@defra/forms-model 3.0.513 → 3.0.515

package/dist/module/form/form-audit/__stubs__/events.js

@@ -0,0 +1,32 @@
+import { AuditEventMessageCategory, AuditEventMessageSchemaVersion, AuditEventMessageType } from "../enums.js";
+export const formCreatedFormId = '8c772d00-beac-4a29-95cb-033a263d0f1b';
+export function buildFormCreatedMessageData(partialFormCreatedMessageData = {}) {
+  return {
+    formId: formCreatedFormId,
+    slug: 'chemistry',
+    title: 'Chemistry',
+    organisation: 'Defra',
+    teamName: 'Forms Team',
+    teamEmail: 'forms@example.com',
+    ...partialFormCreatedMessageData
+  };
+}
+export function buildAuditUser(auditUser = {}) {
+  return {
+    displayName: 'Enrique Chase',
+    id: '18ab1e08-c921-4bb6-a19c-e677c709cc6d',
+    ...auditUser
+  };
+}
+export function buildFormCreatedMessage(partialFormCreatedMessage = {}) {
+  return {
+    type: AuditEventMessageType.FORM_CREATED,
+    category: AuditEventMessageCategory.FORM,
+    createdAt: new Date('2025-07-23'),
+    createdBy: buildAuditUser(),
+    data: buildFormCreatedMessageData(),
+    schemaVersion: AuditEventMessageSchemaVersion.V1,
+    ...partialFormCreatedMessage
+  };
+}
+//# sourceMappingURL=events.js.map

package/dist/module/form/form-audit/__stubs__/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","names":["AuditEventMessageCategory","AuditEventMessageSchemaVersion","AuditEventMessageType","formCreatedFormId","buildFormCreatedMessageData","partialFormCreatedMessageData","formId","slug","title","organisation","teamName","teamEmail","buildAuditUser","auditUser","displayName","id","buildFormCreatedMessage","partialFormCreatedMessage","type","FORM_CREATED","category","FORM","createdAt","Date","createdBy","data","schemaVersion","V1"],"sources":["../../../../../src/form/form-audit/__stubs__/events.ts"],"sourcesContent":["import {\n  AuditEventMessageCategory,\n  AuditEventMessageSchemaVersion,\n  AuditEventMessageType\n} from '~/src/form/form-audit/enums.js'\nimport {\n  type AuditUser,\n  type FormCreatedMessage,\n  type FormCreatedMessageData\n} from '~/src/form/form-audit/types.js'\n\nexport const formCreatedFormId = '8c772d00-beac-4a29-95cb-033a263d0f1b'\n\nexport function buildFormCreatedMessageData(\n  partialFormCreatedMessageData: Partial<FormCreatedMessageData> = {}\n): FormCreatedMessageData {\n  return {\n    formId: formCreatedFormId,\n    slug: 'chemistry',\n    title: 'Chemistry',\n    organisation: 'Defra',\n    teamName: 'Forms Team',\n    teamEmail: 'forms@example.com',\n    ...partialFormCreatedMessageData\n  }\n}\n\nexport function buildAuditUser(auditUser: Partial<AuditUser> = {}): AuditUser {\n  return {\n    displayName: 'Enrique Chase',\n    id: '18ab1e08-c921-4bb6-a19c-e677c709cc6d',\n    ...auditUser\n  }\n}\n\nexport function buildFormCreatedMessage(\n  partialFormCreatedMessage: Partial<FormCreatedMessage> = {}\n): FormCreatedMessage {\n  return {\n    type: AuditEventMessageType.FORM_CREATED,\n    category: AuditEventMessageCategory.FORM,\n    createdAt: new Date('2025-07-23'),\n    createdBy: buildAuditUser(),\n    data: buildFormCreatedMessageData(),\n    schemaVersion: AuditEventMessageSchemaVersion.V1,\n    ...partialFormCreatedMessage\n  } as FormCreatedMessage\n}\n"],"mappings":"AAAA,SACEA,yBAAyB,EACzBC,8BAA8B,EAC9BC,qBAAqB;AAQvB,OAAO,MAAMC,iBAAiB,GAAG,sCAAsC;AAEvE,OAAO,SAASC,2BAA2BA,CACzCC,6BAA8D,GAAG,CAAC,CAAC,EAC3C;EACxB,OAAO;IACLC,MAAM,EAAEH,iBAAiB;IACzBI,IAAI,EAAE,WAAW;IACjBC,KAAK,EAAE,WAAW;IAClBC,YAAY,EAAE,OAAO;IACrBC,QAAQ,EAAE,YAAY;IACtBC,SAAS,EAAE,mBAAmB;IAC9B,GAAGN;EACL,CAAC;AACH;AAEA,OAAO,SAASO,cAAcA,CAACC,SAA6B,GAAG,CAAC,CAAC,EAAa;EAC5E,OAAO;IACLC,WAAW,EAAE,eAAe;IAC5BC,EAAE,EAAE,sCAAsC;IAC1C,GAAGF;EACL,CAAC;AACH;AAEA,OAAO,SAASG,uBAAuBA,CACrCC,yBAAsD,GAAG,CAAC,CAAC,EACvC;EACpB,OAAO;IACLC,IAAI,EAAEhB,qBAAqB,CAACiB,YAAY;IACxCC,QAAQ,EAAEpB,yBAAyB,CAACqB,IAAI;IACxCC,SAAS,EAAE,IAAIC,IAAI,CAAC,YAAY,CAAC;IACjCC,SAAS,EAAEZ,cAAc,CAAC,CAAC;IAC3Ba,IAAI,EAAErB,2BAA2B,CAAC,CAAC;IACnCsB,aAAa,EAAEzB,8BAA8B,CAAC0B,EAAE;IAChD,GAAGV;EACL,CAAC;AACH","ignoreList":[]}

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

@@ -1,3 +1,7 @@
+export let AuditEventMessageSchemaVersion = /*#__PURE__*/function (AuditEventMessageSchemaVersion) {
+  AuditEventMessageSchemaVersion[AuditEventMessageSchemaVersion["V1"] = 1] = "V1";
+  return AuditEventMessageSchemaVersion;
+}({});
 export let AuditEventMessageCategory = /*#__PURE__*/function (AuditEventMessageCategory) {
   AuditEventMessageCategory["FORM"] = "FORM";
   AuditEventMessageCategory["ENTITLEMENT"] = "ENTITLEMENT";

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

@@ -1 +1 @@
-{"version":3,"file":"enums.js","names":["AuditEventMessageCategory","AuditEventMessageSubCategory","AuditEventMessageType"],"sources":["../../../../src/form/form-audit/enums.ts"],"sourcesContent":["export enum AuditEventMessageCategory {\n  FORM = 'FORM',\n  ENTITLEMENT = 'ENTITLEMENT'\n}\n\nexport enum AuditEventMessageSubCategory {\n  FORM_METADATA = 'FORM_METADATA',\n  FORM_DEFINITION = 'FORM_DEFINITION',\n  FORM_SUBMISSION = 'FORM_SUBMISSION'\n}\n\nexport enum AuditEventMessageType {\n  FORM_CREATED = 'FORM_CREATED',\n  FORM_PUBLISHED = 'FORM_PUBLISHED',\n  FORM_NAME_UPDATED = 'FORM_NAME_UPDATED',\n  FORM_ORGANISATION_UPDATED = 'FORM_ORGANISATION_UPDATED',\n  FORM_TEAM_NAME_UPDATED = 'FORM_TEAM_NAME_UPDATED',\n  FORM_TEAM_EMAIL_UPDATED = 'FORM_TEAM_EMAIL_UPDATED',\n  FORM_SUPPORT_PHONE_UPDATED = 'FORM_SUPPORT_PHONE_UPDATED',\n  FORM_SUPPORT_EMAIL_UPDATED = 'FORM_SUPPORT_EMAIL_UPDATED',\n  FORM_SUPPORT_LINK_UPDATED = 'FORM_SUPPORT_LINK_UPDATED',\n  FORM_PRIVACY_POLICY_LINK_UPDATED = 'FORM_PRIVACY_POLICY_LINK_UPDATED',\n  FORM_NOTIFICATION_EMAIL_UPDATED = 'FORM_NOTIFICATION_EMAIL_UPDATED',\n  FORM_SUBMISSION_GUIDANCE_UPDATED = 'FORM_SUBMISSION_GUIDANCE_UPDATED',\n  FORM_JSON_UPLOADED = 'FORM_JSON_UPLOADED',\n  FORM_JSON_DOWNLOADED = 'FORM_JSON_DOWNLOADED',\n  FORM_DRAFT_CREATED_FROM_LIVE = 'FORM_DRAFT_CREATED_FROM_LIVE',\n  FORM_DRAFT_DELETED = 'FORM_DRAFT_DELETED',\n  FORM_MIGRATED = 'FORM_MIGRATED',\n  FORM_UPDATED = 'FORM_UPDATED'\n}\n"],"mappings":"AAAA,WAAYA,yBAAyB,0BAAzBA,yBAAyB;EAAzBA,yBAAyB;EAAzBA,yBAAyB;EAAA,OAAzBA,yBAAyB;AAAA;AAKrC,WAAYC,4BAA4B,0BAA5BA,4BAA4B;EAA5BA,4BAA4B;EAA5BA,4BAA4B;EAA5BA,4BAA4B;EAAA,OAA5BA,4BAA4B;AAAA;AAMxC,WAAYC,qBAAqB,0BAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAAA,OAArBA,qBAAqB;AAAA","ignoreList":[]}
+{"version":3,"file":"enums.js","names":["AuditEventMessageSchemaVersion","AuditEventMessageCategory","AuditEventMessageSubCategory","AuditEventMessageType"],"sources":["../../../../src/form/form-audit/enums.ts"],"sourcesContent":["export enum AuditEventMessageSchemaVersion {\n  V1 = 1\n}\n\nexport enum AuditEventMessageCategory {\n  FORM = 'FORM',\n  ENTITLEMENT = 'ENTITLEMENT'\n}\n\nexport enum AuditEventMessageSubCategory {\n  FORM_METADATA = 'FORM_METADATA',\n  FORM_DEFINITION = 'FORM_DEFINITION',\n  FORM_SUBMISSION = 'FORM_SUBMISSION'\n}\n\nexport enum AuditEventMessageType {\n  FORM_CREATED = 'FORM_CREATED',\n  FORM_PUBLISHED = 'FORM_PUBLISHED',\n  FORM_NAME_UPDATED = 'FORM_NAME_UPDATED',\n  FORM_ORGANISATION_UPDATED = 'FORM_ORGANISATION_UPDATED',\n  FORM_TEAM_NAME_UPDATED = 'FORM_TEAM_NAME_UPDATED',\n  FORM_TEAM_EMAIL_UPDATED = 'FORM_TEAM_EMAIL_UPDATED',\n  FORM_SUPPORT_PHONE_UPDATED = 'FORM_SUPPORT_PHONE_UPDATED',\n  FORM_SUPPORT_EMAIL_UPDATED = 'FORM_SUPPORT_EMAIL_UPDATED',\n  FORM_SUPPORT_LINK_UPDATED = 'FORM_SUPPORT_LINK_UPDATED',\n  FORM_PRIVACY_POLICY_LINK_UPDATED = 'FORM_PRIVACY_POLICY_LINK_UPDATED',\n  FORM_NOTIFICATION_EMAIL_UPDATED = 'FORM_NOTIFICATION_EMAIL_UPDATED',\n  FORM_SUBMISSION_GUIDANCE_UPDATED = 'FORM_SUBMISSION_GUIDANCE_UPDATED',\n  FORM_JSON_UPLOADED = 'FORM_JSON_UPLOADED',\n  FORM_JSON_DOWNLOADED = 'FORM_JSON_DOWNLOADED',\n  FORM_DRAFT_CREATED_FROM_LIVE = 'FORM_DRAFT_CREATED_FROM_LIVE',\n  FORM_DRAFT_DELETED = 'FORM_DRAFT_DELETED',\n  FORM_MIGRATED = 'FORM_MIGRATED',\n  FORM_UPDATED = 'FORM_UPDATED'\n}\n"],"mappings":"AAAA,WAAYA,8BAA8B,0BAA9BA,8BAA8B;EAA9BA,8BAA8B,CAA9BA,8BAA8B;EAAA,OAA9BA,8BAA8B;AAAA;AAI1C,WAAYC,yBAAyB,0BAAzBA,yBAAyB;EAAzBA,yBAAyB;EAAzBA,yBAAyB;EAAA,OAAzBA,yBAAyB;AAAA;AAKrC,WAAYC,4BAA4B,0BAA5BA,4BAA4B;EAA5BA,4BAA4B;EAA5BA,4BAA4B;EAA5BA,4BAA4B;EAAA,OAA5BA,4BAA4B;AAAA;AAMxC,WAAYC,qBAAqB,0BAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAAA,OAArBA,qBAAqB;AAAA","ignoreList":[]}

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

@@ -1,2 +1,57 @@
-
+import Joi from 'joi';
+import { AuditEventMessageCategory, AuditEventMessageSchemaVersion, AuditEventMessageType } from "./enums.js";
+export const formMessageDataBase = Joi.object({
+  formId: Joi.string().trim().required(),
+  slug: Joi.string().trim().required()
+});
+export const formCreatedMessageData = formMessageDataBase.append({
+  title: Joi.string().trim().required(),
+  organisation: Joi.string().trim().required(),
+  teamName: Joi.string().trim().required(),
+  teamEmail: Joi.string().trim().required()
+});
+export const supportEmailChanges = Joi.object().keys({
+  supportEmail: Joi.string().email().required(),
+  responseTime: Joi.string().required()
+});
+export function supportEmailUpdatedMessageData(schema) {
+  return formMessageDataBase.append({
+    changes: Joi.object().keys({
+      previous: schema,
+      new: schema
+    })
+  });
+}
+export const auditUserSchema = Joi.object().keys({
+  id: Joi.string().uuid().required(),
+  displayName: Joi.string().required()
+});
+export const validCategories = [AuditEventMessageCategory.FORM, AuditEventMessageCategory.ENTITLEMENT];
+export const validTypes = [AuditEventMessageType.FORM_CREATED, AuditEventMessageType.FORM_SUPPORT_EMAIL_UPDATED];
+export const validMessageSchemaVersions = [AuditEventMessageSchemaVersion.V1];
+export const messageSchema = Joi.object().keys({
+  schemaVersion: Joi.string().valid(...validMessageSchemaVersions).required(),
+  type: Joi.string().valid(...validTypes),
+  category: Joi.string().valid(...validCategories).required(),
+  createdAt: Joi.date().required(),
+  createdBy: auditUserSchema.required(),
+  data: Joi.when('type', {
+    switch: [{
+      is: Joi.string().trim().valid(AuditEventMessageType.FORM_CREATED),
+      then: formCreatedMessageData
+    }, {
+      is: Joi.string().trim().valid(AuditEventMessageType.FORM_SUPPORT_EMAIL_UPDATED),
+      then: supportEmailUpdatedMessageData(supportEmailChanges)
+    }]
+  }),
+  messageCreatedAt: Joi.date().required()
+});
+export const auditEvent = Joi.object().keys({
+  message: messageSchema
+});
+export const auditRecord = messageSchema.append({
+  messageId: Joi.string().uuid().required(),
+  entityId: Joi.string().required(),
+  recordCreatedAt: Joi.date().required()
+});
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../../../src/form/form-audit/index.ts"],"sourcesContent":[""],"mappings":"","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Joi","AuditEventMessageCategory","AuditEventMessageSchemaVersion","AuditEventMessageType","formMessageDataBase","object","formId","string","trim","required","slug","formCreatedMessageData","append","title","organisation","teamName","teamEmail","supportEmailChanges","keys","supportEmail","email","responseTime","supportEmailUpdatedMessageData","schema","changes","previous","new","auditUserSchema","id","uuid","displayName","validCategories","FORM","ENTITLEMENT","validTypes","FORM_CREATED","FORM_SUPPORT_EMAIL_UPDATED","validMessageSchemaVersions","V1","messageSchema","schemaVersion","valid","type","category","createdAt","date","createdBy","data","when","switch","is","then","messageCreatedAt","auditEvent","message","auditRecord","messageId","entityId","recordCreatedAt"],"sources":["../../../../src/form/form-audit/index.ts"],"sourcesContent":["import Joi, { type ObjectSchema } from 'joi'\n\nimport {\n  AuditEventMessageCategory,\n  AuditEventMessageSchemaVersion,\n  AuditEventMessageType\n} from '~/src/form/form-audit/enums.js'\nimport {\n  type AuditEvent,\n  type AuditMessage,\n  type AuditRecord,\n  type AuditUser,\n  type ChangesMessageData,\n  type FormCreatedMessageData,\n  type FormMessageDataBase,\n  type SupportEmailChanges,\n  type SupportEmailUpdatedMessageData\n} from '~/src/form/form-audit/types.js'\n\nexport const formMessageDataBase = Joi.object<FormMessageDataBase>({\n  formId: Joi.string().trim().required(),\n  slug: Joi.string().trim().required()\n})\n\nexport const formCreatedMessageData =\n  formMessageDataBase.append<FormCreatedMessageData>({\n    title: Joi.string().trim().required(),\n    organisation: Joi.string().trim().required(),\n    teamName: Joi.string().trim().required(),\n    teamEmail: Joi.string().trim().required()\n  })\n\nexport const supportEmailChanges = Joi.object<SupportEmailChanges>().keys({\n  supportEmail: Joi.string().email().required(),\n  responseTime: Joi.string().required()\n})\n\nexport function supportEmailUpdatedMessageData<T>(schema: ObjectSchema<T>) {\n  return formMessageDataBase.append<SupportEmailUpdatedMessageData>({\n    changes: Joi.object<ChangesMessageData<T>>().keys({\n      previous: schema,\n      new: schema\n    })\n  })\n}\n\nexport const auditUserSchema = Joi.object<AuditUser>().keys({\n  id: Joi.string().uuid().required(),\n  displayName: Joi.string().required()\n})\n\nexport const validCategories = [\n  AuditEventMessageCategory.FORM,\n  AuditEventMessageCategory.ENTITLEMENT\n]\n\nexport const validTypes = [\n  AuditEventMessageType.FORM_CREATED,\n  AuditEventMessageType.FORM_SUPPORT_EMAIL_UPDATED\n]\n\nexport const validMessageSchemaVersions = [AuditEventMessageSchemaVersion.V1]\n\nexport const messageSchema = Joi.object<AuditMessage>().keys({\n  schemaVersion: Joi.string()\n    .valid(...validMessageSchemaVersions)\n    .required(),\n  type: Joi.string().valid(...validTypes),\n  category: Joi.string()\n    .valid(...validCategories)\n    .required(),\n  createdAt: Joi.date().required(),\n  createdBy: auditUserSchema.required(),\n  data: Joi.when('type', {\n    switch: [\n      {\n        is: Joi.string().trim().valid(AuditEventMessageType.FORM_CREATED),\n        then: formCreatedMessageData\n      },\n      {\n        is: Joi.string()\n          .trim()\n          .valid(AuditEventMessageType.FORM_SUPPORT_EMAIL_UPDATED),\n        then: supportEmailUpdatedMessageData(supportEmailChanges)\n      }\n    ]\n  }),\n  messageCreatedAt: Joi.date().required()\n})\n\nexport const auditEvent = Joi.object<AuditEvent>().keys({\n  message: messageSchema\n})\n\nexport const auditRecord = messageSchema.append<AuditRecord>({\n  messageId: Joi.string().uuid().required(),\n  entityId: Joi.string().required(),\n  recordCreatedAt: Joi.date().required()\n})\n"],"mappings":"AAAA,OAAOA,GAAG,MAA6B,KAAK;AAE5C,SACEC,yBAAyB,EACzBC,8BAA8B,EAC9BC,qBAAqB;AAcvB,OAAO,MAAMC,mBAAmB,GAAGJ,GAAG,CAACK,MAAM,CAAsB;EACjEC,MAAM,EAAEN,GAAG,CAACO,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EACtCC,IAAI,EAAEV,GAAG,CAACO,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC,CAAC,CAACC,QAAQ,CAAC;AACrC,CAAC,CAAC;AAEF,OAAO,MAAME,sBAAsB,GACjCP,mBAAmB,CAACQ,MAAM,CAAyB;EACjDC,KAAK,EAAEb,GAAG,CAACO,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EACrCK,YAAY,EAAEd,GAAG,CAACO,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC5CM,QAAQ,EAAEf,GAAG,CAACO,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EACxCO,SAAS,EAAEhB,GAAG,CAACO,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC,CAAC,CAACC,QAAQ,CAAC;AAC1C,CAAC,CAAC;AAEJ,OAAO,MAAMQ,mBAAmB,GAAGjB,GAAG,CAACK,MAAM,CAAsB,CAAC,CAACa,IAAI,CAAC;EACxEC,YAAY,EAAEnB,GAAG,CAACO,MAAM,CAAC,CAAC,CAACa,KAAK,CAAC,CAAC,CAACX,QAAQ,CAAC,CAAC;EAC7CY,YAAY,EAAErB,GAAG,CAACO,MAAM,CAAC,CAAC,CAACE,QAAQ,CAAC;AACtC,CAAC,CAAC;AAEF,OAAO,SAASa,8BAA8BA,CAAIC,MAAuB,EAAE;EACzE,OAAOnB,mBAAmB,CAACQ,MAAM,CAAiC;IAChEY,OAAO,EAAExB,GAAG,CAACK,MAAM,CAAwB,CAAC,CAACa,IAAI,CAAC;MAChDO,QAAQ,EAAEF,MAAM;MAChBG,GAAG,EAAEH;IACP,CAAC;EACH,CAAC,CAAC;AACJ;AAEA,OAAO,MAAMI,eAAe,GAAG3B,GAAG,CAACK,MAAM,CAAY,CAAC,CAACa,IAAI,CAAC;EAC1DU,EAAE,EAAE5B,GAAG,CAACO,MAAM,CAAC,CAAC,CAACsB,IAAI,CAAC,CAAC,CAACpB,QAAQ,CAAC,CAAC;EAClCqB,WAAW,EAAE9B,GAAG,CAACO,MAAM,CAAC,CAAC,CAACE,QAAQ,CAAC;AACrC,CAAC,CAAC;AAEF,OAAO,MAAMsB,eAAe,GAAG,CAC7B9B,yBAAyB,CAAC+B,IAAI,EAC9B/B,yBAAyB,CAACgC,WAAW,CACtC;AAED,OAAO,MAAMC,UAAU,GAAG,CACxB/B,qBAAqB,CAACgC,YAAY,EAClChC,qBAAqB,CAACiC,0BAA0B,CACjD;AAED,OAAO,MAAMC,0BAA0B,GAAG,CAACnC,8BAA8B,CAACoC,EAAE,CAAC;AAE7E,OAAO,MAAMC,aAAa,GAAGvC,GAAG,CAACK,MAAM,CAAe,CAAC,CAACa,IAAI,CAAC;EAC3DsB,aAAa,EAAExC,GAAG,CAACO,MAAM,CAAC,CAAC,CACxBkC,KAAK,CAAC,GAAGJ,0BAA0B,CAAC,CACpC5B,QAAQ,CAAC,CAAC;EACbiC,IAAI,EAAE1C,GAAG,CAACO,MAAM,CAAC,CAAC,CAACkC,KAAK,CAAC,GAAGP,UAAU,CAAC;EACvCS,QAAQ,EAAE3C,GAAG,CAACO,MAAM,CAAC,CAAC,CACnBkC,KAAK,CAAC,GAAGV,eAAe,CAAC,CACzBtB,QAAQ,CAAC,CAAC;EACbmC,SAAS,EAAE5C,GAAG,CAAC6C,IAAI,CAAC,CAAC,CAACpC,QAAQ,CAAC,CAAC;EAChCqC,SAAS,EAAEnB,eAAe,CAAClB,QAAQ,CAAC,CAAC;EACrCsC,IAAI,EAAE/C,GAAG,CAACgD,IAAI,CAAC,MAAM,EAAE;IACrBC,MAAM,EAAE,CACN;MACEC,EAAE,EAAElD,GAAG,CAACO,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC,CAAC,CAACiC,KAAK,CAACtC,qBAAqB,CAACgC,YAAY,CAAC;MACjEgB,IAAI,EAAExC;IACR,CAAC,EACD;MACEuC,EAAE,EAAElD,GAAG,CAACO,MAAM,CAAC,CAAC,CACbC,IAAI,CAAC,CAAC,CACNiC,KAAK,CAACtC,qBAAqB,CAACiC,0BAA0B,CAAC;MAC1De,IAAI,EAAE7B,8BAA8B,CAACL,mBAAmB;IAC1D,CAAC;EAEL,CAAC,CAAC;EACFmC,gBAAgB,EAAEpD,GAAG,CAAC6C,IAAI,CAAC,CAAC,CAACpC,QAAQ,CAAC;AACxC,CAAC,CAAC;AAEF,OAAO,MAAM4C,UAAU,GAAGrD,GAAG,CAACK,MAAM,CAAa,CAAC,CAACa,IAAI,CAAC;EACtDoC,OAAO,EAAEf;AACX,CAAC,CAAC;AAEF,OAAO,MAAMgB,WAAW,GAAGhB,aAAa,CAAC3B,MAAM,CAAc;EAC3D4C,SAAS,EAAExD,GAAG,CAACO,MAAM,CAAC,CAAC,CAACsB,IAAI,CAAC,CAAC,CAACpB,QAAQ,CAAC,CAAC;EACzCgD,QAAQ,EAAEzD,GAAG,CAACO,MAAM,CAAC,CAAC,CAACE,QAAQ,CAAC,CAAC;EACjCiD,eAAe,EAAE1D,GAAG,CAAC6C,IAAI,CAAC,CAAC,CAACpC,QAAQ,CAAC;AACvC,CAAC,CAAC","ignoreList":[]}

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-audit/types.ts"],"sourcesContent":["import {\n  type AuditEventMessageCategory,\n  type AuditEventMessageType\n} from '~/src/form/form-audit/enums.js'\n\nexport interface FormMessageData {\n  formId: string\n  slug: string\n}\n\nexport interface ChangesMessageData<T> {\n  previous: T\n  new: T\n}\n\nexport interface FormCreatedMessageData extends FormMessageData {\n  title: string\n  organisation: string\n  teamName: string\n  teamEmail: string\n  createdAt: Date\n  createdBy: {\n    id: string\n    displayName: string\n  }\n  updatedAt: Date\n  updatedBy: {\n    id: string\n    displayName: string\n  }\n}\n\nexport interface SupportEmailUpdatedMessageData extends FormMessageData {\n  changes: ChangesMessageData<{ supportEmail: string; responseTime: string }>\n}\n\nexport type MessageData =\n  | FormCreatedMessageData\n  | SupportEmailUpdatedMessageData\n\nexport interface BaseMessage {\n  schemaVersion: string\n  category: AuditEventMessageCategory\n  type: AuditEventMessageType\n  createdAt: Date\n  createdBy: {\n    id: string\n    displayName: string\n  }\n  data: MessageData\n}\n\nexport interface FormCreatedMessage extends BaseMessage {\n  category: AuditEventMessageCategory.FORM\n  type: AuditEventMessageType.FORM_CREATED\n  data: FormCreatedMessageData\n}\n\nexport interface SupportEmailUpdatedMessage extends BaseMessage {\n  category: AuditEventMessageCategory.FORM\n  type: AuditEventMessageType.FORM_SUPPORT_EMAIL_UPDATED\n  data: SupportEmailUpdatedMessageData\n}\n\nexport type Message = FormCreatedMessage | SupportEmailUpdatedMessage\n\nexport interface AuditEvent {\n  message: Message\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-audit/types.ts"],"sourcesContent":["import {\n  type AuditEventMessageCategory,\n  type AuditEventMessageSchemaVersion,\n  type AuditEventMessageType\n} from '~/src/form/form-audit/enums.js'\n\nexport interface FormMessageDataBase {\n  formId: string\n  slug: string\n}\n\nexport interface ChangesMessageData<T> {\n  previous: T\n  new: T\n}\n\nexport interface FormCreatedMessageData extends FormMessageDataBase {\n  title: string\n  organisation: string\n  teamName: string\n  teamEmail: string\n}\n\nexport interface SupportEmailChanges {\n  supportEmail: string\n  responseTime: string\n}\n\nexport interface SupportEmailUpdatedMessageData extends FormMessageDataBase {\n  changes: ChangesMessageData<SupportEmailChanges>\n}\n\nexport interface AuditUser {\n  id: string\n  displayName: string\n}\n\nexport type MessageData =\n  | FormCreatedMessageData\n  | SupportEmailUpdatedMessageData\n\nexport interface MessageBase {\n  schemaVersion: AuditEventMessageSchemaVersion\n  category: AuditEventMessageCategory\n  type: AuditEventMessageType\n  createdAt: Date\n  createdBy: AuditUser\n  data: MessageData\n  messageCreatedAt: Date\n}\n\nexport interface FormCreatedMessage extends MessageBase {\n  category: AuditEventMessageCategory.FORM\n  type: AuditEventMessageType.FORM_CREATED\n  data: FormCreatedMessageData\n}\n\nexport interface FormSupportEmailUpdatedMessage extends MessageBase {\n  category: AuditEventMessageCategory.FORM\n  type: AuditEventMessageType.FORM_SUPPORT_EMAIL_UPDATED\n  data: SupportEmailUpdatedMessageData\n}\n\nexport type AuditMessage = FormCreatedMessage | FormSupportEmailUpdatedMessage\n\nexport interface AuditEvent {\n  message: AuditMessage\n}\n\nexport type AuditRecord = AuditMessage & {\n  messageId: string\n  entityId: string\n  recordCreatedAt: Date\n}\n\nexport interface MessageBody {\n  Message: string\n}\n"],"mappings":"","ignoreList":[]}

package/dist/module/stubs.js

@@ -15,4 +15,5 @@ export { buildMarkdownComponent } from "./__stubs__/components.js";
 export { QuestionRendererStub } from "./form/form-editor/__stubs__/preview.js";
 export { PageRendererStub } from "./form/form-editor/__stubs__/preview.js";
 export { QuestionPreviewElements } from "./form/form-editor/__stubs__/preview.js";
+export * from "./form/form-audit/__stubs__/events.js";
 //# sourceMappingURL=stubs.js.map

package/dist/module/stubs.js.map

@@ -1 +1 @@
-{"version":3,"file":"stubs.js","names":["buildList","buildListItem","buildCheckboxComponent","buildRadioComponent","buildAutoCompleteComponent","buildNumberFieldComponent","buildFileUploadComponent","buildTextFieldComponent","buildRepeaterPage","buildFileUploadPage","buildSummaryPage","buildQuestionPage","buildMarkdownComponent","QuestionRendererStub","PageRendererStub","QuestionPreviewElements"],"sources":["../../src/stubs.ts"],"sourcesContent":["export * from '~/src/__stubs__/form-definition.js'\nexport { buildList } from '~/src/__stubs__/components.js'\nexport { buildListItem } from '~/src/__stubs__/components.js'\nexport { buildCheckboxComponent } from '~/src/__stubs__/components.js'\nexport { buildRadioComponent } from '~/src/__stubs__/components.js'\nexport { buildAutoCompleteComponent } from '~/src/__stubs__/components.js'\nexport { buildNumberFieldComponent } from '~/src/__stubs__/components.js'\nexport { buildFileUploadComponent } from '~/src/__stubs__/components.js'\nexport { buildTextFieldComponent } from '~/src/__stubs__/components.js'\nexport { buildRepeaterPage } from '~/src/__stubs__/pages.js'\nexport { buildFileUploadPage } from '~/src/__stubs__/pages.js'\nexport { buildSummaryPage } from '~/src/__stubs__/pages.js'\nexport { buildQuestionPage } from '~/src/__stubs__/pages.js'\nexport { buildMarkdownComponent } from '~/src/__stubs__/components.js'\nexport { QuestionRendererStub } from '~/src/form/form-editor/__stubs__/preview.js'\nexport { PageRendererStub } from '~/src/form/form-editor/__stubs__/preview.js'\nexport { QuestionPreviewElements } from '~/src/form/form-editor/__stubs__/preview.js'\n"],"mappings":"AAAA;AACA,SAASA,SAAS;AAClB,SAASC,aAAa;AACtB,SAASC,sBAAsB;AAC/B,SAASC,mBAAmB;AAC5B,SAASC,0BAA0B;AACnC,SAASC,yBAAyB;AAClC,SAASC,wBAAwB;AACjC,SAASC,uBAAuB;AAChC,SAASC,iBAAiB;AAC1B,SAASC,mBAAmB;AAC5B,SAASC,gBAAgB;AACzB,SAASC,iBAAiB;AAC1B,SAASC,sBAAsB;AAC/B,SAASC,oBAAoB;AAC7B,SAASC,gBAAgB;AACzB,SAASC,uBAAuB","ignoreList":[]}
+{"version":3,"file":"stubs.js","names":["buildList","buildListItem","buildCheckboxComponent","buildRadioComponent","buildAutoCompleteComponent","buildNumberFieldComponent","buildFileUploadComponent","buildTextFieldComponent","buildRepeaterPage","buildFileUploadPage","buildSummaryPage","buildQuestionPage","buildMarkdownComponent","QuestionRendererStub","PageRendererStub","QuestionPreviewElements"],"sources":["../../src/stubs.ts"],"sourcesContent":["export * from '~/src/__stubs__/form-definition.js'\nexport { buildList } from '~/src/__stubs__/components.js'\nexport { buildListItem } from '~/src/__stubs__/components.js'\nexport { buildCheckboxComponent } from '~/src/__stubs__/components.js'\nexport { buildRadioComponent } from '~/src/__stubs__/components.js'\nexport { buildAutoCompleteComponent } from '~/src/__stubs__/components.js'\nexport { buildNumberFieldComponent } from '~/src/__stubs__/components.js'\nexport { buildFileUploadComponent } from '~/src/__stubs__/components.js'\nexport { buildTextFieldComponent } from '~/src/__stubs__/components.js'\nexport { buildRepeaterPage } from '~/src/__stubs__/pages.js'\nexport { buildFileUploadPage } from '~/src/__stubs__/pages.js'\nexport { buildSummaryPage } from '~/src/__stubs__/pages.js'\nexport { buildQuestionPage } from '~/src/__stubs__/pages.js'\nexport { buildMarkdownComponent } from '~/src/__stubs__/components.js'\nexport { QuestionRendererStub } from '~/src/form/form-editor/__stubs__/preview.js'\nexport { PageRendererStub } from '~/src/form/form-editor/__stubs__/preview.js'\nexport { QuestionPreviewElements } from '~/src/form/form-editor/__stubs__/preview.js'\nexport * from '~/src/form/form-audit/__stubs__/events.js'\n"],"mappings":"AAAA;AACA,SAASA,SAAS;AAClB,SAASC,aAAa;AACtB,SAASC,sBAAsB;AAC/B,SAASC,mBAAmB;AAC5B,SAASC,0BAA0B;AACnC,SAASC,yBAAyB;AAClC,SAASC,wBAAwB;AACjC,SAASC,uBAAuB;AAChC,SAASC,iBAAiB;AAC1B,SAASC,mBAAmB;AAC5B,SAASC,gBAAgB;AACzB,SAASC,iBAAiB;AAC1B,SAASC,sBAAsB;AAC/B,SAASC,oBAAoB;AAC7B,SAASC,gBAAgB;AACzB,SAASC,uBAAuB;AAChC","ignoreList":[]}

package/dist/types/form/form-audit/__stubs__/events.d.ts

@@ -0,0 +1,6 @@
+import { type AuditUser, type FormCreatedMessage, type FormCreatedMessageData } from '../../../form/form-audit/types.js';
+export declare const formCreatedFormId = "8c772d00-beac-4a29-95cb-033a263d0f1b";
+export declare function buildFormCreatedMessageData(partialFormCreatedMessageData?: Partial<FormCreatedMessageData>): FormCreatedMessageData;
+export declare function buildAuditUser(auditUser?: Partial<AuditUser>): AuditUser;
+export declare function buildFormCreatedMessage(partialFormCreatedMessage?: Partial<FormCreatedMessage>): FormCreatedMessage;
+//# sourceMappingURL=events.d.ts.map

package/dist/types/form/form-audit/__stubs__/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../../src/form/form-audit/__stubs__/events.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,KAAK,SAAS,EACd,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC5B,MAAM,gCAAgC,CAAA;AAEvC,eAAO,MAAM,iBAAiB,yCAAyC,CAAA;AAEvE,wBAAgB,2BAA2B,CACzC,6BAA6B,GAAE,OAAO,CAAC,sBAAsB,CAAM,GAClE,sBAAsB,CAUxB;AAED,wBAAgB,cAAc,CAAC,SAAS,GAAE,OAAO,CAAC,SAAS,CAAM,GAAG,SAAS,CAM5E;AAED,wBAAgB,uBAAuB,CACrC,yBAAyB,GAAE,OAAO,CAAC,kBAAkB,CAAM,GAC1D,kBAAkB,CAUpB"}

package/dist/types/form/form-audit/enums.d.ts

@@ -1,3 +1,6 @@
+export declare enum AuditEventMessageSchemaVersion {
+    V1 = 1
+}
 export declare enum AuditEventMessageCategory {
     FORM = "FORM",
     ENTITLEMENT = "ENTITLEMENT"

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

@@ -1 +1 @@
-{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../../../src/form/form-audit/enums.ts"],"names":[],"mappings":"AAAA,oBAAY,yBAAyB;IACnC,IAAI,SAAS;IACb,WAAW,gBAAgB;CAC5B;AAED,oBAAY,4BAA4B;IACtC,aAAa,kBAAkB;IAC/B,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;CACpC;AAED,oBAAY,qBAAqB;IAC/B,YAAY,iBAAiB;IAC7B,cAAc,mBAAmB;IACjC,iBAAiB,sBAAsB;IACvC,yBAAyB,8BAA8B;IACvD,sBAAsB,2BAA2B;IACjD,uBAAuB,4BAA4B;IACnD,0BAA0B,+BAA+B;IACzD,0BAA0B,+BAA+B;IACzD,yBAAyB,8BAA8B;IACvD,gCAAgC,qCAAqC;IACrE,+BAA+B,oCAAoC;IACnE,gCAAgC,qCAAqC;IACrE,kBAAkB,uBAAuB;IACzC,oBAAoB,yBAAyB;IAC7C,4BAA4B,iCAAiC;IAC7D,kBAAkB,uBAAuB;IACzC,aAAa,kBAAkB;IAC/B,YAAY,iBAAiB;CAC9B"}
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../../../src/form/form-audit/enums.ts"],"names":[],"mappings":"AAAA,oBAAY,8BAA8B;IACxC,EAAE,IAAI;CACP;AAED,oBAAY,yBAAyB;IACnC,IAAI,SAAS;IACb,WAAW,gBAAgB;CAC5B;AAED,oBAAY,4BAA4B;IACtC,aAAa,kBAAkB;IAC/B,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;CACpC;AAED,oBAAY,qBAAqB;IAC/B,YAAY,iBAAiB;IAC7B,cAAc,mBAAmB;IACjC,iBAAiB,sBAAsB;IACvC,yBAAyB,8BAA8B;IACvD,sBAAsB,2BAA2B;IACjD,uBAAuB,4BAA4B;IACnD,0BAA0B,+BAA+B;IACzD,0BAA0B,+BAA+B;IACzD,yBAAyB,8BAA8B;IACvD,gCAAgC,qCAAqC;IACrE,+BAA+B,oCAAoC;IACnE,gCAAgC,qCAAqC;IACrE,kBAAkB,uBAAuB;IACzC,oBAAoB,yBAAyB;IAC7C,4BAA4B,iCAAiC;IAC7D,kBAAkB,uBAAuB;IACzC,aAAa,kBAAkB;IAC/B,YAAY,iBAAiB;CAC9B"}

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

@@ -1,2 +1,15 @@
-export {};
+import Joi, { type ObjectSchema } from 'joi';
+import { AuditEventMessageCategory, AuditEventMessageSchemaVersion, AuditEventMessageType } from '../../form/form-audit/enums.js';
+import { type AuditEvent, type AuditMessage, type AuditRecord, type AuditUser, type FormCreatedMessageData, type FormMessageDataBase, type SupportEmailChanges, type SupportEmailUpdatedMessageData } from '../../form/form-audit/types.js';
+export declare const formMessageDataBase: Joi.ObjectSchema<FormMessageDataBase>;
+export declare const formCreatedMessageData: Joi.ObjectSchema<FormCreatedMessageData>;
+export declare const supportEmailChanges: Joi.ObjectSchema<SupportEmailChanges>;
+export declare function supportEmailUpdatedMessageData<T>(schema: ObjectSchema<T>): Joi.ObjectSchema<SupportEmailUpdatedMessageData>;
+export declare const auditUserSchema: Joi.ObjectSchema<AuditUser>;
+export declare const validCategories: AuditEventMessageCategory[];
+export declare const validTypes: AuditEventMessageType[];
+export declare const validMessageSchemaVersions: AuditEventMessageSchemaVersion[];
+export declare const messageSchema: Joi.ObjectSchema<AuditMessage>;
+export declare const auditEvent: Joi.ObjectSchema<AuditEvent>;
+export declare const auditRecord: Joi.ObjectSchema<AuditRecord>;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-audit/index.ts"],"names":[],"mappings":""}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-audit/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,EAAE,EAAE,KAAK,YAAY,EAAE,MAAM,KAAK,CAAA;AAE5C,OAAO,EACL,yBAAyB,EACzB,8BAA8B,EAC9B,qBAAqB,EACtB,MAAM,gCAAgC,CAAA;AACvC,OAAO,EACL,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,SAAS,EAEd,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,8BAA8B,EACpC,MAAM,gCAAgC,CAAA;AAEvC,eAAO,MAAM,mBAAmB,uCAG9B,CAAA;AAEF,eAAO,MAAM,sBAAsB,0CAM/B,CAAA;AAEJ,eAAO,MAAM,mBAAmB,uCAG9B,CAAA;AAEF,wBAAgB,8BAA8B,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,oDAOxE;AAED,eAAO,MAAM,eAAe,6BAG1B,CAAA;AAEF,eAAO,MAAM,eAAe,6BAG3B,CAAA;AAED,eAAO,MAAM,UAAU,yBAGtB,CAAA;AAED,eAAO,MAAM,0BAA0B,kCAAsC,CAAA;AAE7E,eAAO,MAAM,aAAa,gCAyBxB,CAAA;AAEF,eAAO,MAAM,UAAU,8BAErB,CAAA;AAEF,eAAO,MAAM,WAAW,+BAItB,CAAA"}

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

@@ -1,5 +1,5 @@
-import { type AuditEventMessageCategory, type AuditEventMessageType } from '../../form/form-audit/enums.js';
-export interface FormMessageData {
+import { type AuditEventMessageCategory, type AuditEventMessageSchemaVersion, type AuditEventMessageType } from '../../form/form-audit/enums.js';
+export interface FormMessageDataBase {
     formId: string;
     slug: string;
 }
@@ -7,52 +7,53 @@ export interface ChangesMessageData<T> {
     previous: T;
     new: T;
 }
-export interface FormCreatedMessageData extends FormMessageData {
+export interface FormCreatedMessageData extends FormMessageDataBase {
     title: string;
     organisation: string;
     teamName: string;
     teamEmail: string;
-    createdAt: Date;
-    createdBy: {
-        id: string;
-        displayName: string;
-    };
-    updatedAt: Date;
-    updatedBy: {
-        id: string;
-        displayName: string;
-    };
-}
-export interface SupportEmailUpdatedMessageData extends FormMessageData {
-    changes: ChangesMessageData<{
-        supportEmail: string;
-        responseTime: string;
-    }>;
+}
+export interface SupportEmailChanges {
+    supportEmail: string;
+    responseTime: string;
+}
+export interface SupportEmailUpdatedMessageData extends FormMessageDataBase {
+    changes: ChangesMessageData<SupportEmailChanges>;
+}
+export interface AuditUser {
+    id: string;
+    displayName: string;
 }
 export type MessageData = FormCreatedMessageData | SupportEmailUpdatedMessageData;
-export interface BaseMessage {
-    schemaVersion: string;
+export interface MessageBase {
+    schemaVersion: AuditEventMessageSchemaVersion;
     category: AuditEventMessageCategory;
     type: AuditEventMessageType;
     createdAt: Date;
-    createdBy: {
-        id: string;
-        displayName: string;
-    };
+    createdBy: AuditUser;
     data: MessageData;
+    messageCreatedAt: Date;
 }
-export interface FormCreatedMessage extends BaseMessage {
+export interface FormCreatedMessage extends MessageBase {
     category: AuditEventMessageCategory.FORM;
     type: AuditEventMessageType.FORM_CREATED;
     data: FormCreatedMessageData;
 }
-export interface SupportEmailUpdatedMessage extends BaseMessage {
+export interface FormSupportEmailUpdatedMessage extends MessageBase {
     category: AuditEventMessageCategory.FORM;
     type: AuditEventMessageType.FORM_SUPPORT_EMAIL_UPDATED;
     data: SupportEmailUpdatedMessageData;
 }
-export type Message = FormCreatedMessage | SupportEmailUpdatedMessage;
+export type AuditMessage = FormCreatedMessage | FormSupportEmailUpdatedMessage;
 export interface AuditEvent {
-    message: Message;
+    message: AuditMessage;
+}
+export type AuditRecord = AuditMessage & {
+    messageId: string;
+    entityId: string;
+    recordCreatedAt: Date;
+};
+export interface MessageBody {
+    Message: string;
 }
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-audit/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,yBAAyB,EAC9B,KAAK,qBAAqB,EAC3B,MAAM,gCAAgC,CAAA;AAEvC,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC,QAAQ,EAAE,CAAC,CAAA;IACX,GAAG,EAAE,CAAC,CAAA;CACP;AAED,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC7D,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,IAAI,CAAA;IACf,SAAS,EAAE;QACT,EAAE,EAAE,MAAM,CAAA;QACV,WAAW,EAAE,MAAM,CAAA;KACpB,CAAA;IACD,SAAS,EAAE,IAAI,CAAA;IACf,SAAS,EAAE;QACT,EAAE,EAAE,MAAM,CAAA;QACV,WAAW,EAAE,MAAM,CAAA;KACpB,CAAA;CACF;AAED,MAAM,WAAW,8BAA+B,SAAQ,eAAe;IACrE,OAAO,EAAE,kBAAkB,CAAC;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;CAC5E;AAED,MAAM,MAAM,WAAW,GACnB,sBAAsB,GACtB,8BAA8B,CAAA;AAElC,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,yBAAyB,CAAA;IACnC,IAAI,EAAE,qBAAqB,CAAA;IAC3B,SAAS,EAAE,IAAI,CAAA;IACf,SAAS,EAAE;QACT,EAAE,EAAE,MAAM,CAAA;QACV,WAAW,EAAE,MAAM,CAAA;KACpB,CAAA;IACD,IAAI,EAAE,WAAW,CAAA;CAClB;AAED,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,YAAY,CAAA;IACxC,IAAI,EAAE,sBAAsB,CAAA;CAC7B;AAED,MAAM,WAAW,0BAA2B,SAAQ,WAAW;IAC7D,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,0BAA0B,CAAA;IACtD,IAAI,EAAE,8BAA8B,CAAA;CACrC;AAED,MAAM,MAAM,OAAO,GAAG,kBAAkB,GAAG,0BAA0B,CAAA;AAErE,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,OAAO,CAAA;CACjB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-audit/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,yBAAyB,EAC9B,KAAK,8BAA8B,EACnC,KAAK,qBAAqB,EAC3B,MAAM,gCAAgC,CAAA;AAEvC,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC,QAAQ,EAAE,CAAC,CAAA;IACX,GAAG,EAAE,CAAC,CAAA;CACP;AAED,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,8BAA+B,SAAQ,mBAAmB;IACzE,OAAO,EAAE,kBAAkB,CAAC,mBAAmB,CAAC,CAAA;CACjD;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,MAAM,WAAW,GACnB,sBAAsB,GACtB,8BAA8B,CAAA;AAElC,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,8BAA8B,CAAA;IAC7C,QAAQ,EAAE,yBAAyB,CAAA;IACnC,IAAI,EAAE,qBAAqB,CAAA;IAC3B,SAAS,EAAE,IAAI,CAAA;IACf,SAAS,EAAE,SAAS,CAAA;IACpB,IAAI,EAAE,WAAW,CAAA;IACjB,gBAAgB,EAAE,IAAI,CAAA;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,YAAY,CAAA;IACxC,IAAI,EAAE,sBAAsB,CAAA;CAC7B;AAED,MAAM,WAAW,8BAA+B,SAAQ,WAAW;IACjE,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,0BAA0B,CAAA;IACtD,IAAI,EAAE,8BAA8B,CAAA;CACrC;AAED,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,8BAA8B,CAAA;AAE9E,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,YAAY,CAAA;CACtB;AAED,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG;IACvC,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,eAAe,EAAE,IAAI,CAAA;CACtB,CAAA;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAA;CAChB"}

package/dist/types/stubs.d.ts

@@ -15,4 +15,5 @@ export { buildMarkdownComponent } from './__stubs__/components.js';
 export { QuestionRendererStub } from './form/form-editor/__stubs__/preview.js';
 export { PageRendererStub } from './form/form-editor/__stubs__/preview.js';
 export { QuestionPreviewElements } from './form/form-editor/__stubs__/preview.js';
+export * from './form/form-audit/__stubs__/events.js';
 //# sourceMappingURL=stubs.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"stubs.d.ts","sourceRoot":"","sources":["../../src/stubs.ts"],"names":[],"mappings":"AAAA,cAAc,oCAAoC,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAA;AACtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAA;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAA;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAA;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAA;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,6CAA6C,CAAA;AAClF,OAAO,EAAE,gBAAgB,EAAE,MAAM,6CAA6C,CAAA;AAC9E,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAA"}
+{"version":3,"file":"stubs.d.ts","sourceRoot":"","sources":["../../src/stubs.ts"],"names":[],"mappings":"AAAA,cAAc,oCAAoC,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAA;AACtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAA;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAA;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAA;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAA;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,6CAA6C,CAAA;AAClF,OAAO,EAAE,gBAAgB,EAAE,MAAM,6CAA6C,CAAA;AAC9E,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAA;AACrF,cAAc,2CAA2C,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.513",
+  "version": "3.0.515",
   "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-audit/__stubs__/events.ts

@@ -0,0 +1,48 @@
+import {
+  AuditEventMessageCategory,
+  AuditEventMessageSchemaVersion,
+  AuditEventMessageType
+} from '~/src/form/form-audit/enums.js'
+import {
+  type AuditUser,
+  type FormCreatedMessage,
+  type FormCreatedMessageData
+} from '~/src/form/form-audit/types.js'
+
+export const formCreatedFormId = '8c772d00-beac-4a29-95cb-033a263d0f1b'
+
+export function buildFormCreatedMessageData(
+  partialFormCreatedMessageData: Partial<FormCreatedMessageData> = {}
+): FormCreatedMessageData {
+  return {
+    formId: formCreatedFormId,
+    slug: 'chemistry',
+    title: 'Chemistry',
+    organisation: 'Defra',
+    teamName: 'Forms Team',
+    teamEmail: 'forms@example.com',
+    ...partialFormCreatedMessageData
+  }
+}
+
+export function buildAuditUser(auditUser: Partial<AuditUser> = {}): AuditUser {
+  return {
+    displayName: 'Enrique Chase',
+    id: '18ab1e08-c921-4bb6-a19c-e677c709cc6d',
+    ...auditUser
+  }
+}
+
+export function buildFormCreatedMessage(
+  partialFormCreatedMessage: Partial<FormCreatedMessage> = {}
+): FormCreatedMessage {
+  return {
+    type: AuditEventMessageType.FORM_CREATED,
+    category: AuditEventMessageCategory.FORM,
+    createdAt: new Date('2025-07-23'),
+    createdBy: buildAuditUser(),
+    data: buildFormCreatedMessageData(),
+    schemaVersion: AuditEventMessageSchemaVersion.V1,
+    ...partialFormCreatedMessage
+  } as FormCreatedMessage
+}

package/src/form/form-audit/enums.ts

@@ -1,3 +1,7 @@
+export enum AuditEventMessageSchemaVersion {
+  V1 = 1
+}
+
 export enum AuditEventMessageCategory {
   FORM = 'FORM',
   ENTITLEMENT = 'ENTITLEMENT'

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

@@ -0,0 +1,99 @@
+import Joi, { type ObjectSchema } from 'joi'
+
+import {
+  AuditEventMessageCategory,
+  AuditEventMessageSchemaVersion,
+  AuditEventMessageType
+} from '~/src/form/form-audit/enums.js'
+import {
+  type AuditEvent,
+  type AuditMessage,
+  type AuditRecord,
+  type AuditUser,
+  type ChangesMessageData,
+  type FormCreatedMessageData,
+  type FormMessageDataBase,
+  type SupportEmailChanges,
+  type SupportEmailUpdatedMessageData
+} from '~/src/form/form-audit/types.js'
+
+export const formMessageDataBase = Joi.object<FormMessageDataBase>({
+  formId: Joi.string().trim().required(),
+  slug: Joi.string().trim().required()
+})
+
+export const formCreatedMessageData =
+  formMessageDataBase.append<FormCreatedMessageData>({
+    title: Joi.string().trim().required(),
+    organisation: Joi.string().trim().required(),
+    teamName: Joi.string().trim().required(),
+    teamEmail: Joi.string().trim().required()
+  })
+
+export const supportEmailChanges = Joi.object<SupportEmailChanges>().keys({
+  supportEmail: Joi.string().email().required(),
+  responseTime: Joi.string().required()
+})
+
+export function supportEmailUpdatedMessageData<T>(schema: ObjectSchema<T>) {
+  return formMessageDataBase.append<SupportEmailUpdatedMessageData>({
+    changes: Joi.object<ChangesMessageData<T>>().keys({
+      previous: schema,
+      new: schema
+    })
+  })
+}
+
+export const auditUserSchema = Joi.object<AuditUser>().keys({
+  id: Joi.string().uuid().required(),
+  displayName: Joi.string().required()
+})
+
+export const validCategories = [
+  AuditEventMessageCategory.FORM,
+  AuditEventMessageCategory.ENTITLEMENT
+]
+
+export const validTypes = [
+  AuditEventMessageType.FORM_CREATED,
+  AuditEventMessageType.FORM_SUPPORT_EMAIL_UPDATED
+]
+
+export const validMessageSchemaVersions = [AuditEventMessageSchemaVersion.V1]
+
+export const messageSchema = Joi.object<AuditMessage>().keys({
+  schemaVersion: Joi.string()
+    .valid(...validMessageSchemaVersions)
+    .required(),
+  type: Joi.string().valid(...validTypes),
+  category: Joi.string()
+    .valid(...validCategories)
+    .required(),
+  createdAt: Joi.date().required(),
+  createdBy: auditUserSchema.required(),
+  data: Joi.when('type', {
+    switch: [
+      {
+        is: Joi.string().trim().valid(AuditEventMessageType.FORM_CREATED),
+        then: formCreatedMessageData
+      },
+      {
+        is: Joi.string()
+          .trim()
+          .valid(AuditEventMessageType.FORM_SUPPORT_EMAIL_UPDATED),
+        then: supportEmailUpdatedMessageData(supportEmailChanges)
+      }
+    ]
+  }),
+  messageCreatedAt: Joi.date().required()
+})
+
+export const auditEvent = Joi.object<AuditEvent>().keys({
+  message: messageSchema
+})
+
+export const auditRecord = messageSchema.append<AuditRecord>({
+  messageId: Joi.string().uuid().required(),
+  entityId: Joi.string().required(),
+  recordCreatedAt: Joi.date().required()
+})

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

@@ -1,9 +1,10 @@
 import {
   type AuditEventMessageCategory,
+  type AuditEventMessageSchemaVersion,
   type AuditEventMessageType
 } from '~/src/form/form-audit/enums.js'
 
-export interface FormMessageData {
+export interface FormMessageDataBase {
   formId: string
   slug: string
 }
@@ -13,57 +14,65 @@ export interface ChangesMessageData<T> {
   new: T
 }
 
-export interface FormCreatedMessageData extends FormMessageData {
+export interface FormCreatedMessageData extends FormMessageDataBase {
   title: string
   organisation: string
   teamName: string
   teamEmail: string
-  createdAt: Date
-  createdBy: {
-    id: string
-    displayName: string
-  }
-  updatedAt: Date
-  updatedBy: {
-    id: string
-    displayName: string
-  }
 }
 
-export interface SupportEmailUpdatedMessageData extends FormMessageData {
-  changes: ChangesMessageData<{ supportEmail: string; responseTime: string }>
+export interface SupportEmailChanges {
+  supportEmail: string
+  responseTime: string
+}
+
+export interface SupportEmailUpdatedMessageData extends FormMessageDataBase {
+  changes: ChangesMessageData<SupportEmailChanges>
+}
+
+export interface AuditUser {
+  id: string
+  displayName: string
 }
 
 export type MessageData =
   | FormCreatedMessageData
   | SupportEmailUpdatedMessageData
 
-export interface BaseMessage {
-  schemaVersion: string
+export interface MessageBase {
+  schemaVersion: AuditEventMessageSchemaVersion
   category: AuditEventMessageCategory
   type: AuditEventMessageType
   createdAt: Date
-  createdBy: {
-    id: string
-    displayName: string
-  }
+  createdBy: AuditUser
   data: MessageData
+  messageCreatedAt: Date
 }
 
-export interface FormCreatedMessage extends BaseMessage {
+export interface FormCreatedMessage extends MessageBase {
   category: AuditEventMessageCategory.FORM
   type: AuditEventMessageType.FORM_CREATED
   data: FormCreatedMessageData
 }
 
-export interface SupportEmailUpdatedMessage extends BaseMessage {
+export interface FormSupportEmailUpdatedMessage extends MessageBase {
   category: AuditEventMessageCategory.FORM
   type: AuditEventMessageType.FORM_SUPPORT_EMAIL_UPDATED
   data: SupportEmailUpdatedMessageData
 }
 
-export type Message = FormCreatedMessage | SupportEmailUpdatedMessage
+export type AuditMessage = FormCreatedMessage | FormSupportEmailUpdatedMessage
 
 export interface AuditEvent {
-  message: Message
+  message: AuditMessage
+}
+
+export type AuditRecord = AuditMessage & {
+  messageId: string
+  entityId: string
+  recordCreatedAt: Date
+}
+
+export interface MessageBody {
+  Message: string
 }

package/src/stubs.ts

@@ -15,3 +15,4 @@ export { buildMarkdownComponent } from '~/src/__stubs__/components.js'
 export { QuestionRendererStub } from '~/src/form/form-editor/__stubs__/preview.js'
 export { PageRendererStub } from '~/src/form/form-editor/__stubs__/preview.js'
 export { QuestionPreviewElements } from '~/src/form/form-editor/__stubs__/preview.js'
+export * from '~/src/form/form-audit/__stubs__/events.js'