@defra/forms-model 3.0.378 → 3.0.379

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

@@ -0,0 +1,32 @@
+import Joi from 'joi';
+/**
+ * Joi schema for `SubmitRecord` interface
+ * @see {@link SubmitRecord}
+ */
+export const formSubmitRecordSchema = Joi.object({
+  name: Joi.string().required(),
+  title: Joi.string().required(),
+  value: Joi.string().required()
+});
+
+/**
+ * Joi schema for `SubmitRecordset` interface
+ * @see {@link SubmitRecordset}
+ */
+export const formSubmitRecordsetSchema = Joi.object({
+  name: Joi.string().required(),
+  title: Joi.string().required(),
+  value: Joi.array().items(Joi.array().items(formSubmitRecordSchema).required()).required()
+});
+
+/**
+ * Joi schema for `SubmitPayload` interface
+ * @see {@link SubmitPayload}
+ */
+export const formSubmitPayloadSchema = Joi.object().keys({
+  retrievalKey: Joi.string().required(),
+  sessionId: Joi.string().required(),
+  main: Joi.array().items(formSubmitRecordSchema).required(),
+  repeaters: Joi.array().items(formSubmitRecordsetSchema).required()
+}).required();
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["Joi","formSubmitRecordSchema","object","name","string","required","title","value","formSubmitRecordsetSchema","array","items","formSubmitPayloadSchema","keys","retrievalKey","sessionId","main","repeaters"],"sources":["../../../../src/form/form-submission/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport {\n  type SubmitPayload,\n  type SubmitRecord,\n  type SubmitRecordset\n} from '~/src/form/form-submission/types.js'\n\n/**\n * Joi schema for `SubmitRecord` interface\n * @see {@link SubmitRecord}\n */\nexport const formSubmitRecordSchema = Joi.object<SubmitRecord>({\n  name: Joi.string().required(),\n  title: Joi.string().required(),\n  value: Joi.string().required()\n})\n\n/**\n * Joi schema for `SubmitRecordset` interface\n * @see {@link SubmitRecordset}\n */\nexport const formSubmitRecordsetSchema = Joi.object<SubmitRecordset>({\n  name: Joi.string().required(),\n  title: Joi.string().required(),\n  value: Joi.array<SubmitRecord[]>()\n    .items(Joi.array<SubmitRecord>().items(formSubmitRecordSchema).required())\n    .required()\n})\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().required(),\n    sessionId: Joi.string().required(),\n    main: Joi.array<SubmitRecord>().items(formSubmitRecordSchema).required(),\n    repeaters: Joi.array<SubmitRecordset>()\n      .items(formSubmitRecordsetSchema)\n      .required()\n  })\n  .required()\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAQrB;AACA;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAGD,GAAG,CAACE,MAAM,CAAe;EAC7DC,IAAI,EAAEH,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC7BC,KAAK,EAAEN,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC9BE,KAAK,EAAEP,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;AAC/B,CAAC,CAAC;;AAEF;AACA;AACA;AACA;AACA,OAAO,MAAMG,yBAAyB,GAAGR,GAAG,CAACE,MAAM,CAAkB;EACnEC,IAAI,EAAEH,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC7BC,KAAK,EAAEN,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC9BE,KAAK,EAAEP,GAAG,CAACS,KAAK,CAAiB,CAAC,CAC/BC,KAAK,CAACV,GAAG,CAACS,KAAK,CAAe,CAAC,CAACC,KAAK,CAACT,sBAAsB,CAAC,CAACI,QAAQ,CAAC,CAAC,CAAC,CACzEA,QAAQ,CAAC;AACd,CAAC,CAAC;;AAEF;AACA;AACA;AACA;AACA,OAAO,MAAMM,uBAAuB,GAAGX,GAAG,CAACE,MAAM,CAAgB,CAAC,CAC/DU,IAAI,CAAC;EACJC,YAAY,EAAEb,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EACrCS,SAAS,EAAEd,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAClCU,IAAI,EAAEf,GAAG,CAACS,KAAK,CAAe,CAAC,CAACC,KAAK,CAACT,sBAAsB,CAAC,CAACI,QAAQ,CAAC,CAAC;EACxEW,SAAS,EAAEhB,GAAG,CAACS,KAAK,CAAkB,CAAC,CACpCC,KAAK,CAACF,yBAAyB,CAAC,CAChCH,QAAQ,CAAC;AACd,CAAC,CAAC,CACDA,QAAQ,CAAC,CAAC","ignoreList":[]}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-submission/types.ts"],"sourcesContent":["import {\n  formSubmitPayloadSchema,\n  formSubmitRecordSchema,\n  formSubmitRecordsetSchema\n} from '~/src/form/form-submission/index.js'\n\n/**\n * Interface for an individual submit record\n * @see {@link formSubmitRecordSchema}\n */\nexport interface SubmitRecord {\n  /**\n   * The field name\n   */\n  name: string\n\n  /**\n   * The field title\n   */\n  title: string\n\n  /**\n   * The field display value\n   */\n  value: string\n}\n\n/**\n * Interface for an individual submit recordset (e.g. a repeater question set)\n * @see {@link formSubmitRecordsetSchema}\n */\nexport interface SubmitRecordset {\n  /**\n   * The name of the recordset\n   */\n  name: string\n\n  /**\n   * The title of the recordset\n   */\n  title: string\n\n  /**\n   * The record items\n   */\n  value: SubmitRecord[][]\n}\n\n/**\n * Interface for the submission-api `/submit` payload\n * @see {@link formSubmitPayloadSchema}\n */\nexport interface SubmitPayload {\n  /**\n   * The retrieval key for files created in the submission\n   */\n  retrievalKey: string\n\n  /**\n   * The id of the user session\n   */\n  sessionId: string\n\n  /**\n   * The main form anwsers\n   */\n  main: SubmitRecord[]\n\n  /**\n   * The repeaters form answers\n   */\n  repeaters: SubmitRecordset[]\n}\n\n/**\n * Interface for the submission-api `/submit` response payload\n */\nexport interface SubmitResponsePayload {\n  message: string\n  result: {\n    files: {\n      main: string\n      repeaters: Record<string, string>\n    }\n  }\n}\n"],"mappings":"","ignoreList":[]}

package/dist/module/index.js

@@ -1,5 +1,6 @@
 export * from "./form/form-definition/index.js";
 export * from "./form/form-metadata/index.js";
+export * from "./form/form-submission/index.js";
 export * from "./form/utils/index.js";
 export * from "./components/index.js";
 export * from "./conditions/index.js";

package/dist/module/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-metadata/index.js'\nexport * from '~/src/form/utils/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/pages/index.js'\nexport * from '~/src/utils/helpers.js'\nexport * from '~/src/utils/markdown.js'\nexport type * from '~/src/components/types.js'\nexport type * from '~/src/conditions/types.js'\nexport type * from '~/src/form/form-definition/types.js'\nexport type * from '~/src/form/form-metadata/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-metadata/index.js'\nexport * from '~/src/form/form-submission/index.js'\nexport * from '~/src/form/utils/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/pages/index.js'\nexport * from '~/src/utils/helpers.js'\nexport * from '~/src/utils/markdown.js'\nexport type * from '~/src/components/types.js'\nexport type * from '~/src/conditions/types.js'\nexport type * from '~/src/form/form-definition/types.js'\nexport type * from '~/src/form/form-metadata/types.js'\nexport type * from '~/src/form/form-submission/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAErB,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,eAAe,EACrB,MAAM,qCAAqC,CAAA;AAE5C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,gCAIjC,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,yBAAyB,mCAMpC,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,iCASvB,CAAA"}

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

@@ -0,0 +1,71 @@
+/**
+ * Interface for an individual submit record
+ * @see {@link formSubmitRecordSchema}
+ */
+export interface SubmitRecord {
+    /**
+     * The field name
+     */
+    name: string;
+    /**
+     * The field title
+     */
+    title: string;
+    /**
+     * The field display value
+     */
+    value: string;
+}
+/**
+ * Interface for an individual submit recordset (e.g. a repeater question set)
+ * @see {@link formSubmitRecordsetSchema}
+ */
+export interface SubmitRecordset {
+    /**
+     * The name of the recordset
+     */
+    name: string;
+    /**
+     * The title of the recordset
+     */
+    title: string;
+    /**
+     * The record items
+     */
+    value: SubmitRecord[][];
+}
+/**
+ * Interface for the submission-api `/submit` payload
+ * @see {@link formSubmitPayloadSchema}
+ */
+export interface SubmitPayload {
+    /**
+     * The retrieval key for files created in the submission
+     */
+    retrievalKey: string;
+    /**
+     * The id of the user session
+     */
+    sessionId: string;
+    /**
+     * The main form anwsers
+     */
+    main: SubmitRecord[];
+    /**
+     * The repeaters form answers
+     */
+    repeaters: SubmitRecordset[];
+}
+/**
+ * Interface for the submission-api `/submit` response payload
+ */
+export interface SubmitResponsePayload {
+    message: string;
+    result: {
+        files: {
+            main: string;
+            repeaters: Record<string, string>;
+        };
+    };
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/types.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,EAAE,CAAA;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,IAAI,EAAE,YAAY,EAAE,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,eAAe,EAAE,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE;QACN,KAAK,EAAE;YACL,IAAI,EAAE,MAAM,CAAA;YACZ,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;SAClC,CAAA;KACF,CAAA;CACF"}

package/dist/types/index.d.ts

@@ -1,5 +1,6 @@
 export * from './form/form-definition/index.js';
 export * from './form/form-metadata/index.js';
+export * from './form/form-submission/index.js';
 export * from './form/utils/index.js';
 export * from './components/index.js';
 export * from './conditions/index.js';
@@ -10,4 +11,5 @@ export type * from './components/types.js';
 export type * from './conditions/types.js';
 export type * from './form/form-definition/types.js';
 export type * from './form/form-metadata/types.js';
+export type * from './form/form-submission/types.js';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAA;AACnD,cAAc,mCAAmC,CAAA;AACjD,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAA;AACnD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA;AACtD,mBAAmB,qCAAqC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.378",
+  "version": "3.0.379",
   "description": "A hapi plugin providing the model for Defra forms",
   "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
   "repository": {

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

@@ -0,0 +1,44 @@
+import Joi from 'joi'
+
+import {
+  type SubmitPayload,
+  type SubmitRecord,
+  type SubmitRecordset
+} from '~/src/form/form-submission/types.js'
+
+/**
+ * Joi schema for `SubmitRecord` interface
+ * @see {@link SubmitRecord}
+ */
+export const formSubmitRecordSchema = Joi.object<SubmitRecord>({
+  name: Joi.string().required(),
+  title: Joi.string().required(),
+  value: Joi.string().required()
+})
+
+/**
+ * Joi schema for `SubmitRecordset` interface
+ * @see {@link SubmitRecordset}
+ */
+export const formSubmitRecordsetSchema = Joi.object<SubmitRecordset>({
+  name: Joi.string().required(),
+  title: Joi.string().required(),
+  value: Joi.array<SubmitRecord[]>()
+    .items(Joi.array<SubmitRecord>().items(formSubmitRecordSchema).required())
+    .required()
+})
+
+/**
+ * Joi schema for `SubmitPayload` interface
+ * @see {@link SubmitPayload}
+ */
+export const formSubmitPayloadSchema = Joi.object<SubmitPayload>()
+  .keys({
+    retrievalKey: Joi.string().required(),
+    sessionId: Joi.string().required(),
+    main: Joi.array<SubmitRecord>().items(formSubmitRecordSchema).required(),
+    repeaters: Joi.array<SubmitRecordset>()
+      .items(formSubmitRecordsetSchema)
+      .required()
+  })
+  .required()

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

@@ -0,0 +1,86 @@
+import {
+  formSubmitPayloadSchema,
+  formSubmitRecordSchema,
+  formSubmitRecordsetSchema
+} from '~/src/form/form-submission/index.js'
+
+/**
+ * Interface for an individual submit record
+ * @see {@link formSubmitRecordSchema}
+ */
+export interface SubmitRecord {
+  /**
+   * The field name
+   */
+  name: string
+
+  /**
+   * The field title
+   */
+  title: string
+
+  /**
+   * The field display value
+   */
+  value: string
+}
+
+/**
+ * Interface for an individual submit recordset (e.g. a repeater question set)
+ * @see {@link formSubmitRecordsetSchema}
+ */
+export interface SubmitRecordset {
+  /**
+   * The name of the recordset
+   */
+  name: string
+
+  /**
+   * The title of the recordset
+   */
+  title: string
+
+  /**
+   * The record items
+   */
+  value: SubmitRecord[][]
+}
+
+/**
+ * Interface for the submission-api `/submit` payload
+ * @see {@link formSubmitPayloadSchema}
+ */
+export interface SubmitPayload {
+  /**
+   * The retrieval key for files created in the submission
+   */
+  retrievalKey: string
+
+  /**
+   * The id of the user session
+   */
+  sessionId: string
+
+  /**
+   * The main form anwsers
+   */
+  main: SubmitRecord[]
+
+  /**
+   * The repeaters form answers
+   */
+  repeaters: SubmitRecordset[]
+}
+
+/**
+ * Interface for the submission-api `/submit` response payload
+ */
+export interface SubmitResponsePayload {
+  message: string
+  result: {
+    files: {
+      main: string
+      repeaters: Record<string, string>
+    }
+  }
+}

package/src/index.ts

@@ -1,5 +1,6 @@
 export * from '~/src/form/form-definition/index.js'
 export * from '~/src/form/form-metadata/index.js'
+export * from '~/src/form/form-submission/index.js'
 export * from '~/src/form/utils/index.js'
 export * from '~/src/components/index.js'
 export * from '~/src/conditions/index.js'
@@ -10,3 +11,4 @@ export type * from '~/src/components/types.js'
 export type * from '~/src/conditions/types.js'
 export type * from '~/src/form/form-definition/types.js'
 export type * from '~/src/form/form-metadata/types.js'
+export type * from '~/src/form/form-submission/types.js'