@defra/forms-model 3.0.514 → 3.0.516

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,8BAA8B,EACnC,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;CAClB;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,8BAA8B,CAAA;IAC7C,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,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,wBAAwB;IACvC,gBAAgB,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,4BAA4B;IAC3C,iBAAiB,EAAE,MAAM,CAAA;CAC1B;AAED,MAAM,WAAW,6BAA6B;IAC5C,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE,OAAO,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAA;CAC9C;AAED,MAAM,WAAW,kCACf,SAAQ,mBAAmB;IAC3B,OAAO,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,CAAA;CACrD;AAED,MAAM,WAAW,8BAA+B,SAAQ,mBAAmB;IACzE,OAAO,EAAE,kBAAkB,CAAC,mBAAmB,CAAC,CAAA;CACjD;AAED,MAAM,WAAW,+BAAgC,SAAQ,mBAAmB;IAC1E,OAAO,EAAE,kBAAkB,CAAC,oBAAoB,CAAC,CAAA;CAClD;AAED,MAAM,WAAW,kCACf,SAAQ,mBAAmB;IAC3B,OAAO,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,CAAA;CACrD;AAED,MAAM,WAAW,kCACf,SAAQ,mBAAmB;IAC3B,OAAO,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,CAAA;CACrD;AAED,MAAM,WAAW,mCACf,SAAQ,mBAAmB;IAC3B,OAAO,EAAE,kBAAkB,CAAC,wBAAwB,CAAC,CAAA;CACtD;AAED,MAAM,WAAW,mCACf,SAAQ,mBAAmB;IAC3B,OAAO,EAAE,kBAAkB,CAAC,wBAAwB,CAAC,CAAA;CACtD;AAED,MAAM,WAAW,uCACf,SAAQ,mBAAmB;IAC3B,OAAO,EAAE,kBAAkB,CAAC,4BAA4B,CAAC,CAAA;CAC1D;AAED,MAAM,WAAW,wCACf,SAAQ,mBAAmB;IAC3B,OAAO,EAAE,kBAAkB,CAAC,6BAA6B,CAAC,CAAA;CAC3D;AAED,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IAClE,OAAO,EAAE,kBAAkB,CAAC,mBAAmB,CAAC,CAAA;CACjD;AAED,MAAM,MAAM,sBAAsB,GAC9B,2BAA2B,GAC3B,kCAAkC,GAClC,8BAA8B,GAC9B,+BAA+B,GAC/B,kCAAkC,GAClC,kCAAkC,GAClC,mCAAmC,GACnC,mCAAmC,GACnC,uCAAuC,GACvC,wCAAwC,GACxC,uBAAuB,CAAA;AAE3B,MAAM,MAAM,yBAAyB,GACjC,sBAAsB,GACtB,sBAAsB,CAAA;AAE1B,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,MAAM,WAAW,GAAG,sBAAsB,GAAG,yBAAyB,CAAA;AAE5E,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,8BAA8B,CAAA;IAC7C,QAAQ,EAAE,yBAAyB,CAAA;IACnC,IAAI,EAAE,qBAAqB,CAAA;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,IAAI,CAAA;IACf,SAAS,EAAE,SAAS,CAAA;IACpB,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,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,uBAAwB,SAAQ,WAAW;IAC1D,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,kBAAkB,CAAA;IAC9C,IAAI,EAAE,2BAA2B,CAAA;CAClC;AAED,MAAM,WAAW,8BAA+B,SAAQ,WAAW;IACjE,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,yBAAyB,CAAA;IACrD,IAAI,EAAE,kCAAkC,CAAA;CACzC;AAED,MAAM,WAAW,0BAA2B,SAAQ,WAAW;IAC7D,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,sBAAsB,CAAA;IAClD,IAAI,EAAE,8BAA8B,CAAA;CACrC;AAED,MAAM,WAAW,2BAA4B,SAAQ,WAAW;IAC9D,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,uBAAuB,CAAA;IACnD,IAAI,EAAE,+BAA+B,CAAA;CACtC;AAED,MAAM,WAAW,8BAA+B,SAAQ,WAAW;IACjE,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,0BAA0B,CAAA;IACtD,IAAI,EAAE,kCAAkC,CAAA;CACzC;AAED,MAAM,WAAW,8BAA+B,SAAQ,WAAW;IACjE,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,0BAA0B,CAAA;IACtD,IAAI,EAAE,kCAAkC,CAAA;CACzC;AAED,MAAM,WAAW,+BAAgC,SAAQ,WAAW;IAClE,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,2BAA2B,CAAA;IACvD,IAAI,EAAE,mCAAmC,CAAA;CAC1C;AAED,MAAM,WAAW,sCAAuC,SAAQ,WAAW;IACzE,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,2BAA2B,CAAA;IACvD,IAAI,EAAE,mCAAmC,CAAA;CAC1C;AAED,MAAM,WAAW,0CACf,SAAQ,WAAW;IACnB,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,+BAA+B,CAAA;IAC3D,IAAI,EAAE,uCAAuC,CAAA;CAC9C;AAED,MAAM,WAAW,2CACf,SAAQ,WAAW;IACnB,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,gCAAgC,CAAA;IAC5D,IAAI,EAAE,wCAAwC,CAAA;CAC/C;AAED,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,kBAAkB,CAAA;IAC9C,IAAI,EAAE,uBAAuB,CAAA;CAC9B;AAED,MAAM,WAAW,qBAAsB,SAAQ,WAAW;IACxD,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,oBAAoB,CAAA;CACjD;AAED,MAAM,WAAW,oBAAqB,SAAQ,WAAW;IACvD,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,cAAc,CAAA;CAC3C;AAED,MAAM,WAAW,+BAAgC,SAAQ,WAAW;IAClE,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,4BAA4B,CAAA;CACzD;AAED,MAAM,WAAW,+BAAgC,SAAQ,WAAW;IAClE,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,4BAA4B,CAAA;CACzD;AAED,MAAM,WAAW,uBAAwB,SAAQ,WAAW;IAC1D,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,kBAAkB,CAAA;CAC/C;AAED,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,aAAa,CAAA;CAC1C;AAED,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAA;IACxC,IAAI,EAAE,qBAAqB,CAAC,YAAY,CAAA;CACzC;AAED,MAAM,MAAM,YAAY,GACpB,kBAAkB,GAClB,uBAAuB,GACvB,8BAA8B,GAC9B,0BAA0B,GAC1B,2BAA2B,GAC3B,8BAA8B,GAC9B,8BAA8B,GAC9B,+BAA+B,GAC/B,sCAAsC,GACtC,0CAA0C,GAC1C,2CAA2C,GAC3C,mBAAmB,GACnB,qBAAqB,GACrB,oBAAoB,GACpB,+BAA+B,GAC/B,+BAA+B,GAC/B,uBAAuB,GACvB,mBAAmB,GACnB,kBAAkB,CAAA;AAEtB,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,YAAY,CAAA;CACtB;AAED,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG;IACvC,SAAS,EAAE,MAAM,CAAA;IACjB,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.514",
+  "version": "3.0.516",
   "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

@@ -16,19 +16,20 @@ export enum AuditEventMessageSubCategory {
 export enum AuditEventMessageType {
   FORM_CREATED = 'FORM_CREATED',
   FORM_PUBLISHED = 'FORM_PUBLISHED',
-  FORM_NAME_UPDATED = 'FORM_NAME_UPDATED',
+  FORM_TITLE_UPDATED = 'FORM_TITLE_UPDATED',
   FORM_ORGANISATION_UPDATED = 'FORM_ORGANISATION_UPDATED',
   FORM_TEAM_NAME_UPDATED = 'FORM_TEAM_NAME_UPDATED',
   FORM_TEAM_EMAIL_UPDATED = 'FORM_TEAM_EMAIL_UPDATED',
   FORM_SUPPORT_PHONE_UPDATED = 'FORM_SUPPORT_PHONE_UPDATED',
   FORM_SUPPORT_EMAIL_UPDATED = 'FORM_SUPPORT_EMAIL_UPDATED',
-  FORM_SUPPORT_LINK_UPDATED = 'FORM_SUPPORT_LINK_UPDATED',
-  FORM_PRIVACY_POLICY_LINK_UPDATED = 'FORM_PRIVACY_POLICY_LINK_UPDATED',
+  FORM_SUPPORT_ONLINE_UPDATED = 'FORM_SUPPORT_ONLINE_UPDATED',
+  FORM_PRIVACY_NOTICE_UPDATED = 'FORM_PRIVACY_NOTICE_UPDATED',
   FORM_NOTIFICATION_EMAIL_UPDATED = 'FORM_NOTIFICATION_EMAIL_UPDATED',
   FORM_SUBMISSION_GUIDANCE_UPDATED = 'FORM_SUBMISSION_GUIDANCE_UPDATED',
   FORM_JSON_UPLOADED = 'FORM_JSON_UPLOADED',
   FORM_JSON_DOWNLOADED = 'FORM_JSON_DOWNLOADED',
   FORM_DRAFT_CREATED_FROM_LIVE = 'FORM_DRAFT_CREATED_FROM_LIVE',
+  FORM_LIVE_CREATED_FROM_DRAFT = 'FORM_LIVE_CREATED_FROM_DRAFT',
   FORM_DRAFT_DELETED = 'FORM_DRAFT_DELETED',
   FORM_MIGRATED = 'FORM_MIGRATED',
   FORM_UPDATED = 'FORM_UPDATED'

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

@@ -0,0 +1,303 @@
+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 FormMessageChangesData,
+  type FormMessageDataBase,
+  type FormNotificationEmailChanges,
+  type FormNotificationEmailUpdatedMessageData,
+  type FormOrganisationChanges,
+  type FormOrganisationUpdatedMessageData,
+  type FormPrivacyNoticeChanges,
+  type FormPrivacyNoticeUpdatedMessageData,
+  type FormSubmissionGuidanceChanges,
+  type FormSubmissionGuidanceUpdatedMessageData,
+  type FormSupportEmailChanges,
+  type FormSupportEmailUpdatedMessageData,
+  type FormSupportOnlineChanges,
+  type FormSupportOnlineUpdatedMessageData,
+  type FormSupportPhoneChanges,
+  type FormSupportPhoneUpdatedMessageData,
+  type FormTeamEmailChanges,
+  type FormTeamEmailUpdatedMessageData,
+  type FormTeamNameChanges,
+  type FormTeamNameUpdatedMessageData,
+  type FormTitleChanges,
+  type FormTitleUpdatedMessageData,
+  type FormUpdatedMessageData,
+  type FormUploadedChanges,
+  type FormUploadedMessageData
+} from '~/src/form/form-audit/types.js'
+
+export const formMessageDataBase = Joi.object<FormMessageDataBase>({
+  formId: Joi.string().required(),
+  slug: Joi.string().required()
+})
+
+export const formCreatedMessageData =
+  formMessageDataBase.append<FormCreatedMessageData>({
+    title: Joi.string().required(),
+    organisation: Joi.string().required(),
+    teamName: Joi.string().required(),
+    teamEmail: Joi.string().required()
+  })
+
+export const formUpdatedMessageData =
+  formMessageDataBase.append<FormUpdatedMessageData>({
+    description: Joi.string().trim().required()
+  })
+
+export const formTitleChanges = Joi.object<FormTitleChanges>()
+  .keys({
+    title: Joi.string().required()
+  })
+  .required()
+
+export const formOrganisationChanges = Joi.object<FormOrganisationChanges>()
+  .keys({
+    organisation: Joi.string().required()
+  })
+  .required()
+
+export const formTeamNameChanges = Joi.object<FormTeamNameChanges>()
+  .keys({
+    teamName: Joi.string().required()
+  })
+  .required()
+
+export const formTeamEmailChanges = Joi.object<FormTeamEmailChanges>()
+  .keys({
+    teamEmail: Joi.string().required()
+  })
+  .required()
+
+export const formSupportPhoneChanges = Joi.object<FormSupportPhoneChanges>()
+  .keys({
+    phone: Joi.string().required()
+  })
+  .required()
+
+export const formSupportOnlineChanges = Joi.object<FormSupportOnlineChanges>()
+  .keys({
+    url: Joi.string().required(),
+    text: Joi.string().required()
+  })
+  .required()
+
+export const formPrivacyNoticeChanges = Joi.object<FormPrivacyNoticeChanges>()
+  .keys({
+    privacyNoticeUrl: Joi.string().required()
+  })
+  .required()
+
+export const formNotificationEmailChanges =
+  Joi.object<FormNotificationEmailChanges>()
+    .keys({
+      notificationEmail: Joi.string().required()
+    })
+    .required()
+
+export const formSubmissionGuidanceChanges =
+  Joi.object<FormSubmissionGuidanceChanges>()
+    .keys({
+      submissionGuidance: Joi.string().required()
+    })
+    .required()
+
+export const formUploadedChanges = Joi.object<FormUploadedChanges>()
+  .keys({
+    value: Joi.string().required()
+  })
+  .required()
+
+export const formSupportEmailChanges =
+  Joi.object<FormSupportEmailChanges>().keys({
+    address: Joi.string().email().required(),
+    responseTime: Joi.string().required()
+  })
+
+export function formChangesMessageData<T, U extends FormMessageChangesData>(
+  schema: ObjectSchema<T>
+): ObjectSchema<U> {
+  return formMessageDataBase.append<U>({
+    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_PUBLISHED,
+  AuditEventMessageType.FORM_TITLE_UPDATED,
+  AuditEventMessageType.FORM_ORGANISATION_UPDATED,
+  AuditEventMessageType.FORM_TEAM_NAME_UPDATED,
+  AuditEventMessageType.FORM_TEAM_EMAIL_UPDATED,
+  AuditEventMessageType.FORM_SUPPORT_PHONE_UPDATED,
+  AuditEventMessageType.FORM_SUPPORT_EMAIL_UPDATED,
+  AuditEventMessageType.FORM_SUPPORT_ONLINE_UPDATED,
+  AuditEventMessageType.FORM_PRIVACY_NOTICE_UPDATED,
+  AuditEventMessageType.FORM_NOTIFICATION_EMAIL_UPDATED,
+  AuditEventMessageType.FORM_SUBMISSION_GUIDANCE_UPDATED,
+  AuditEventMessageType.FORM_UPDATED,
+  AuditEventMessageType.FORM_JSON_UPLOADED,
+  AuditEventMessageType.FORM_JSON_DOWNLOADED,
+  AuditEventMessageType.FORM_DRAFT_CREATED_FROM_LIVE,
+  AuditEventMessageType.FORM_LIVE_CREATED_FROM_DRAFT,
+  AuditEventMessageType.FORM_DRAFT_DELETED,
+  AuditEventMessageType.FORM_MIGRATED
+]
+
+export const validMessageSchemaVersions = [AuditEventMessageSchemaVersion.V1]
+
+export const messageSchema = Joi.object<AuditMessage>().keys({
+  entityId: Joi.string().required(),
+  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_TITLE_UPDATED),
+        then: formChangesMessageData<
+          FormTitleChanges,
+          FormTitleUpdatedMessageData
+        >(formTitleChanges)
+      },
+      {
+        is: Joi.string()
+          .trim()
+          .valid(AuditEventMessageType.FORM_ORGANISATION_UPDATED),
+        then: formChangesMessageData<
+          FormOrganisationChanges,
+          FormOrganisationUpdatedMessageData
+        >(formOrganisationChanges)
+      },
+      {
+        is: Joi.string()
+          .trim()
+          .valid(AuditEventMessageType.FORM_TEAM_NAME_UPDATED),
+        then: formChangesMessageData<
+          FormTeamNameChanges,
+          FormTeamNameUpdatedMessageData
+        >(formTeamNameChanges)
+      },
+      {
+        is: Joi.string()
+          .trim()
+          .valid(AuditEventMessageType.FORM_TEAM_EMAIL_UPDATED),
+        then: formChangesMessageData<
+          FormTeamEmailChanges,
+          FormTeamEmailUpdatedMessageData
+        >(formTeamEmailChanges)
+      },
+      {
+        is: Joi.string()
+          .trim()
+          .valid(AuditEventMessageType.FORM_SUPPORT_PHONE_UPDATED),
+        then: formChangesMessageData<
+          FormSupportPhoneChanges,
+          FormSupportPhoneUpdatedMessageData
+        >(formSupportPhoneChanges)
+      },
+      {
+        is: Joi.string()
+          .trim()
+          .valid(AuditEventMessageType.FORM_SUPPORT_EMAIL_UPDATED),
+        then: formChangesMessageData<
+          FormSupportEmailChanges,
+          FormSupportEmailUpdatedMessageData
+        >(formSupportEmailChanges)
+      },
+      {
+        is: Joi.string()
+          .trim()
+          .valid(AuditEventMessageType.FORM_SUPPORT_ONLINE_UPDATED),
+        then: formChangesMessageData<
+          FormSupportOnlineChanges,
+          FormSupportOnlineUpdatedMessageData
+        >(formSupportOnlineChanges)
+      },
+      {
+        is: Joi.string()
+          .trim()
+          .valid(AuditEventMessageType.FORM_PRIVACY_NOTICE_UPDATED),
+        then: formChangesMessageData<
+          FormPrivacyNoticeChanges,
+          FormPrivacyNoticeUpdatedMessageData
+        >(formPrivacyNoticeChanges)
+      },
+      {
+        is: Joi.string()
+          .trim()
+          .valid(AuditEventMessageType.FORM_NOTIFICATION_EMAIL_UPDATED),
+        then: formChangesMessageData<
+          FormNotificationEmailChanges,
+          FormNotificationEmailUpdatedMessageData
+        >(formNotificationEmailChanges)
+      },
+      {
+        is: Joi.string()
+          .trim()
+          .valid(AuditEventMessageType.FORM_SUBMISSION_GUIDANCE_UPDATED),
+        then: formChangesMessageData<
+          FormSubmissionGuidanceChanges,
+          FormSubmissionGuidanceUpdatedMessageData
+        >(formSubmissionGuidanceChanges)
+      },
+      {
+        is: Joi.string().trim().valid(AuditEventMessageType.FORM_JSON_UPLOADED),
+        then: formChangesMessageData<
+          FormUploadedChanges,
+          FormUploadedMessageData
+        >(formUploadedChanges)
+      },
+      {
+        is: Joi.string().trim().valid(AuditEventMessageType.FORM_UPDATED),
+        then: formUpdatedMessageData
+      }
+    ]
+  }),
+  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()
+})