@defra/forms-engine-plugin 2.1.4 → 2.1.5

package/src/server/plugins/engine/types/schema.ts

@@ -0,0 +1,45 @@
+import {
+  FormStatus,
+  idSchema,
+  notificationEmailAddressSchema,
+  slugSchema,
+  titleSchema
+} from '@defra/forms-model'
+import Joi from 'joi'
+
+import {
+  FormAdapterSubmissionSchemaVersion,
+  type FormAdapterSubmissionMessageData,
+  type FormAdapterSubmissionMessageMeta,
+  type FormAdapterSubmissionMessagePayload
+} from '~/src/server/plugins/engine/types.js'
+
+export const formAdapterSubmissionMessageMetaSchema =
+  Joi.object<FormAdapterSubmissionMessageMeta>().keys({
+    schemaVersion: Joi.string().valid(
+      ...Object.values(FormAdapterSubmissionSchemaVersion)
+    ),
+    timestamp: Joi.date().required(),
+    referenceNumber: Joi.string().required(),
+    formName: titleSchema,
+    formId: idSchema,
+    formSlug: slugSchema,
+    status: Joi.string()
+      .valid(...Object.values(FormStatus))
+      .required(),
+    isPreview: Joi.boolean().required(),
+    notificationEmail: notificationEmailAddressSchema.required()
+  })
+
+export const formAdapterSubmissionMessageDataSchema =
+  Joi.object<FormAdapterSubmissionMessageData>().keys({
+    main: Joi.object(),
+    repeaters: Joi.object(),
+    files: Joi.object()
+  })
+
+export const formAdapterSubmissionMessagePayloadSchema =
+  Joi.object<FormAdapterSubmissionMessagePayload>().keys({
+    meta: formAdapterSubmissionMessageMetaSchema.required(),
+    data: formAdapterSubmissionMessageDataSchema.required()
+  })

package/src/server/plugins/engine/types.ts

@@ -18,6 +18,7 @@ import {
   type ComponentViewModel
 } from '~/src/server/plugins/engine/components/types.js'
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
+import { type RichFormValue } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'
 import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'
 import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'
 import { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'
@@ -25,7 +26,8 @@ import {
   type FormAction,
   type FormParams,
   type FormRequest,
-  type FormRequestPayload
+  type FormRequestPayload,
+  type FormStatus
 } from '~/src/server/routes/types.js'
 import { type RequestOptions } from '~/src/server/services/httpService.js'
 import { type Services } from '~/src/server/types.js'
@@ -384,3 +386,51 @@ export interface PluginOptions {
   onRequest?: OnRequestCallback
   baseUrl: string // base URL of the application, protocol and hostname e.g. "https://myapp.com"
 }
+
+export interface FormAdapterSubmissionMessageMeta {
+  schemaVersion: FormAdapterSubmissionSchemaVersion
+  timestamp: Date
+  referenceNumber: string
+  formName: string
+  formId: string
+  formSlug: string
+  status: FormStatus
+  isPreview: boolean
+  notificationEmail: string
+}
+
+export type FormAdapterSubmissionMessageMetaSerialised = Omit<
+  FormAdapterSubmissionMessageMeta,
+  'schemaVersion' | 'timestamp' | 'status'
+> & {
+  schemaVersion: string
+  status: string
+  timestamp: string
+}
+
+export interface FormAdapterSubmissionMessageData {
+  main: Record<string, RichFormValue>
+  repeaters: Record<string, Record<string, RichFormValue>[]>
+  files: Record<string, Record<string, string>[]>
+}
+
+export enum FormAdapterSubmissionSchemaVersion {
+  V1 = 1
+}
+
+export interface FormAdapterSubmissionMessagePayload {
+  meta: FormAdapterSubmissionMessageMeta
+  data: FormAdapterSubmissionMessageData
+}
+
+export interface FormAdapterSubmissionMessage
+  extends FormAdapterSubmissionMessagePayload {
+  messageId: string
+  recordCreatedAt: Date
+}
+
+export interface FormAdapterSubmissionService {
+  handleFormSubmission: (
+    submissionMessage: FormAdapterSubmissionMessage
+  ) => unknown
+}

package/src/server/types.ts

@@ -59,6 +59,7 @@ export interface OutputService {
     model: FormModel,
     emailAddress: string,
     items: DetailItem[],
-    submitResponse: SubmitResponsePayload
+    submitResponse: SubmitResponsePayload,
+    formMetadata?: FormMetadata
   ) => Promise<void>
 }