@defra/forms-model 3.0.512 → 3.0.514

package/dist/module/form/form-audit/base-message-schema.json

@@ -0,0 +1,11 @@
+{
+  "schemaVersion": "string",
+  "category": "string",
+  "type": "string",
+  "createdAt": "Date",
+  "createdBy": {
+    "id": "string",
+    "displayName": "string"
+  },
+  "data": "object"
+}

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

@@ -0,0 +1,37 @@
+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";
+  return AuditEventMessageCategory;
+}({});
+export let AuditEventMessageSubCategory = /*#__PURE__*/function (AuditEventMessageSubCategory) {
+  AuditEventMessageSubCategory["FORM_METADATA"] = "FORM_METADATA";
+  AuditEventMessageSubCategory["FORM_DEFINITION"] = "FORM_DEFINITION";
+  AuditEventMessageSubCategory["FORM_SUBMISSION"] = "FORM_SUBMISSION";
+  return AuditEventMessageSubCategory;
+}({});
+export let AuditEventMessageType = /*#__PURE__*/function (AuditEventMessageType) {
+  AuditEventMessageType["FORM_CREATED"] = "FORM_CREATED";
+  AuditEventMessageType["FORM_PUBLISHED"] = "FORM_PUBLISHED";
+  AuditEventMessageType["FORM_NAME_UPDATED"] = "FORM_NAME_UPDATED";
+  AuditEventMessageType["FORM_ORGANISATION_UPDATED"] = "FORM_ORGANISATION_UPDATED";
+  AuditEventMessageType["FORM_TEAM_NAME_UPDATED"] = "FORM_TEAM_NAME_UPDATED";
+  AuditEventMessageType["FORM_TEAM_EMAIL_UPDATED"] = "FORM_TEAM_EMAIL_UPDATED";
+  AuditEventMessageType["FORM_SUPPORT_PHONE_UPDATED"] = "FORM_SUPPORT_PHONE_UPDATED";
+  AuditEventMessageType["FORM_SUPPORT_EMAIL_UPDATED"] = "FORM_SUPPORT_EMAIL_UPDATED";
+  AuditEventMessageType["FORM_SUPPORT_LINK_UPDATED"] = "FORM_SUPPORT_LINK_UPDATED";
+  AuditEventMessageType["FORM_PRIVACY_POLICY_LINK_UPDATED"] = "FORM_PRIVACY_POLICY_LINK_UPDATED";
+  AuditEventMessageType["FORM_NOTIFICATION_EMAIL_UPDATED"] = "FORM_NOTIFICATION_EMAIL_UPDATED";
+  AuditEventMessageType["FORM_SUBMISSION_GUIDANCE_UPDATED"] = "FORM_SUBMISSION_GUIDANCE_UPDATED";
+  AuditEventMessageType["FORM_JSON_UPLOADED"] = "FORM_JSON_UPLOADED";
+  AuditEventMessageType["FORM_JSON_DOWNLOADED"] = "FORM_JSON_DOWNLOADED";
+  AuditEventMessageType["FORM_DRAFT_CREATED_FROM_LIVE"] = "FORM_DRAFT_CREATED_FROM_LIVE";
+  AuditEventMessageType["FORM_DRAFT_DELETED"] = "FORM_DRAFT_DELETED";
+  AuditEventMessageType["FORM_MIGRATED"] = "FORM_MIGRATED";
+  AuditEventMessageType["FORM_UPDATED"] = "FORM_UPDATED";
+  return AuditEventMessageType;
+}({});
+//# sourceMappingURL=enums.js.map

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

@@ -0,0 +1 @@
+{"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/form-created-message-schema.json

@@ -0,0 +1,28 @@
+{
+  "schemaVersion": "string",
+  "category": "FORM",
+  "type": "FORM_CREATED",
+  "createdAt": "Date",
+  "createdBy": {
+    "id": "string",
+    "displayName": "string"
+  },
+  "data": {
+    "formId": "string",
+    "title": "string",
+    "organisation": "string",
+    "teamName": "string",
+    "teamEmail": "string",
+    "slug": "string",
+    "createdAt": "Date",
+    "createdBy": {
+      "id": "string",
+      "displayName": "string"
+    },
+    "updatedAt": "Date",
+    "updatedBy": {
+      "id": "string",
+      "displayName": "string"
+    }
+  }
+}

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

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../../../src/form/form-audit/index.ts"],"sourcesContent":[""],"mappings":"","ignoreList":[]}

package/dist/module/form/form-audit/support-email-updated.json

@@ -0,0 +1,24 @@
+{
+  "schemaVersion": "string",
+  "category": "string",
+  "type": "string",
+  "createdAt": "Date",
+  "createdBy": {
+    "id": "string",
+    "displayName": "string"
+  },
+  "data": {
+    "formId": "string",
+    "slug": "string",
+    "changes": {
+      "previous": {
+        "supportEmail": "string",
+        "responseTime": "string"
+      },
+      "new": {
+        "supportEmail": "string",
+        "responseTime": "string"
+      }
+    }
+  }
+}

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

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

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

@@ -0,0 +1 @@
+{"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 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}\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: AuditEventMessageSchemaVersion\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":[]}

package/dist/module/index.js

@@ -18,4 +18,6 @@ export * from "./form/form-manager/errors.js";
 export * from "./pages/index.js";
 export * from "./utils/helpers.js";
 export * from "./utils/markdown.js";
+export * from "./form/form-audit/index.js";
+export * from "./form/form-audit/enums.js";
 //# sourceMappingURL=index.js.map

package/dist/module/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/common/enums.js'\nexport * from '~/src/common/random-id.js'\nexport * from '~/src/common/schema.js'\nexport * from '~/src/common/pagination/index.js'\nexport * from '~/src/common/search/index.js'\nexport * from '~/src/common/sorting/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-definition/types.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/form/form-editor/index.js'\nexport * from '~/src/form/form-editor/preview/index.js'\nexport * from '~/src/form/form-manager/types.js'\nexport * from '~/src/form/form-manager/errors.js'\nexport * from '~/src/pages/index.js'\nexport * from '~/src/utils/helpers.js'\nexport * from '~/src/utils/markdown.js'\n\nexport type * from '~/src/common/types.js'\nexport type * from '~/src/common/pagination/types.js'\nexport type * from '~/src/common/search/types.js'\nexport type * from '~/src/common/sorting/types.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'\nexport type * from '~/src/form/form-editor/preview/types.js'\nexport type * from '~/src/form/form-editor/types.js'\nexport type * from '~/src/form/form-editor/macros/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/common/enums.js'\nexport * from '~/src/common/random-id.js'\nexport * from '~/src/common/schema.js'\nexport * from '~/src/common/pagination/index.js'\nexport * from '~/src/common/search/index.js'\nexport * from '~/src/common/sorting/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-definition/types.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/form/form-editor/index.js'\nexport * from '~/src/form/form-editor/preview/index.js'\nexport * from '~/src/form/form-manager/types.js'\nexport * from '~/src/form/form-manager/errors.js'\nexport * from '~/src/pages/index.js'\nexport * from '~/src/utils/helpers.js'\nexport * from '~/src/utils/markdown.js'\nexport * from '~/src/form/form-audit/index.js'\nexport * from '~/src/form/form-audit/enums.js'\n\nexport type * from '~/src/common/types.js'\nexport type * from '~/src/common/pagination/types.js'\nexport type * from '~/src/common/search/types.js'\nexport type * from '~/src/common/sorting/types.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'\nexport type * from '~/src/form/form-editor/preview/types.js'\nexport type * from '~/src/form/form-editor/types.js'\nexport type * from '~/src/form/form-editor/macros/types.js'\nexport type * from '~/src/form/form-audit/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

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

@@ -0,0 +1,33 @@
+export declare enum AuditEventMessageSchemaVersion {
+    V1 = 1
+}
+export declare enum AuditEventMessageCategory {
+    FORM = "FORM",
+    ENTITLEMENT = "ENTITLEMENT"
+}
+export declare enum AuditEventMessageSubCategory {
+    FORM_METADATA = "FORM_METADATA",
+    FORM_DEFINITION = "FORM_DEFINITION",
+    FORM_SUBMISSION = "FORM_SUBMISSION"
+}
+export declare enum AuditEventMessageType {
+    FORM_CREATED = "FORM_CREATED",
+    FORM_PUBLISHED = "FORM_PUBLISHED",
+    FORM_NAME_UPDATED = "FORM_NAME_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_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_DRAFT_DELETED = "FORM_DRAFT_DELETED",
+    FORM_MIGRATED = "FORM_MIGRATED",
+    FORM_UPDATED = "FORM_UPDATED"
+}
+//# sourceMappingURL=enums.d.ts.map

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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-audit/index.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,48 @@
+import { type AuditEventMessageCategory, type AuditEventMessageSchemaVersion, type AuditEventMessageType } from '../../form/form-audit/enums.js';
+export interface FormMessageData {
+    formId: string;
+    slug: string;
+}
+export interface ChangesMessageData<T> {
+    previous: T;
+    new: T;
+}
+export interface FormCreatedMessageData extends FormMessageData {
+    title: string;
+    organisation: string;
+    teamName: string;
+    teamEmail: string;
+}
+export interface SupportEmailUpdatedMessageData extends FormMessageData {
+    changes: ChangesMessageData<{
+        supportEmail: string;
+        responseTime: string;
+    }>;
+}
+export type MessageData = FormCreatedMessageData | SupportEmailUpdatedMessageData;
+export interface BaseMessage {
+    schemaVersion: AuditEventMessageSchemaVersion;
+    category: AuditEventMessageCategory;
+    type: AuditEventMessageType;
+    createdAt: Date;
+    createdBy: {
+        id: string;
+        displayName: string;
+    };
+    data: MessageData;
+}
+export interface FormCreatedMessage extends BaseMessage {
+    category: AuditEventMessageCategory.FORM;
+    type: AuditEventMessageType.FORM_CREATED;
+    data: FormCreatedMessageData;
+}
+export interface SupportEmailUpdatedMessage extends BaseMessage {
+    category: AuditEventMessageCategory.FORM;
+    type: AuditEventMessageType.FORM_SUPPORT_EMAIL_UPDATED;
+    data: SupportEmailUpdatedMessageData;
+}
+export type Message = FormCreatedMessage | SupportEmailUpdatedMessage;
+export interface AuditEvent {
+    message: Message;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +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"}

package/dist/types/index.d.ts

@@ -18,6 +18,8 @@ export * from './form/form-manager/errors.js';
 export * from './pages/index.js';
 export * from './utils/helpers.js';
 export * from './utils/markdown.js';
+export * from './form/form-audit/index.js';
+export * from './form/form-audit/enums.js';
 export type * from './common/types.js';
 export type * from './common/pagination/types.js';
 export type * from './common/search/types.js';
@@ -30,4 +32,5 @@ export type * from './form/form-submission/types.js';
 export type * from './form/form-editor/preview/types.js';
 export type * from './form/form-editor/types.js';
 export type * from './form/form-editor/macros/types.js';
+export type * from './form/form-audit/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,uBAAuB,CAAA;AACrC,cAAc,2BAA2B,CAAA;AACzC,cAAc,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,qCAAqC,CAAA;AACnD,cAAc,qCAAqC,CAAA;AACnD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,iCAAiC,CAAA;AAC/C,cAAc,yCAAyC,CAAA;AACvD,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AAEvC,mBAAmB,uBAAuB,CAAA;AAC1C,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,8BAA8B,CAAA;AACjD,mBAAmB,+BAA+B,CAAA;AAClD,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA;AACtD,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,yCAAyC,CAAA;AAC5D,mBAAmB,iCAAiC,CAAA;AACpD,mBAAmB,wCAAwC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,2BAA2B,CAAA;AACzC,cAAc,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,qCAAqC,CAAA;AACnD,cAAc,qCAAqC,CAAA;AACnD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,iCAAiC,CAAA;AAC/C,cAAc,yCAAyC,CAAA;AACvD,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,gCAAgC,CAAA;AAE9C,mBAAmB,uBAAuB,CAAA;AAC1C,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,8BAA8B,CAAA;AACjD,mBAAmB,+BAA+B,CAAA;AAClD,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA;AACtD,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,yCAAyC,CAAA;AAC5D,mBAAmB,iCAAiC,CAAA;AACpD,mBAAmB,wCAAwC,CAAA;AAC3D,mBAAmB,gCAAgC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.512",
+  "version": "3.0.514",
   "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/base-message-schema.json

@@ -0,0 +1,11 @@
+{
+  "schemaVersion": "string",
+  "category": "string",
+  "type": "string",
+  "createdAt": "Date",
+  "createdBy": {
+    "id": "string",
+    "displayName": "string"
+  },
+  "data": "object"
+}

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

@@ -0,0 +1,35 @@
+export enum AuditEventMessageSchemaVersion {
+  V1 = 1
+}
+
+export enum AuditEventMessageCategory {
+  FORM = 'FORM',
+  ENTITLEMENT = 'ENTITLEMENT'
+}
+
+export enum AuditEventMessageSubCategory {
+  FORM_METADATA = 'FORM_METADATA',
+  FORM_DEFINITION = 'FORM_DEFINITION',
+  FORM_SUBMISSION = 'FORM_SUBMISSION'
+}
+
+export enum AuditEventMessageType {
+  FORM_CREATED = 'FORM_CREATED',
+  FORM_PUBLISHED = 'FORM_PUBLISHED',
+  FORM_NAME_UPDATED = 'FORM_NAME_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_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_DRAFT_DELETED = 'FORM_DRAFT_DELETED',
+  FORM_MIGRATED = 'FORM_MIGRATED',
+  FORM_UPDATED = 'FORM_UPDATED'
+}

package/src/form/form-audit/form-created-message-schema.json

@@ -0,0 +1,28 @@
+{
+  "schemaVersion": "string",
+  "category": "FORM",
+  "type": "FORM_CREATED",
+  "createdAt": "Date",
+  "createdBy": {
+    "id": "string",
+    "displayName": "string"
+  },
+  "data": {
+    "formId": "string",
+    "title": "string",
+    "organisation": "string",
+    "teamName": "string",
+    "teamEmail": "string",
+    "slug": "string",
+    "createdAt": "Date",
+    "createdBy": {
+      "id": "string",
+      "displayName": "string"
+    },
+    "updatedAt": "Date",
+    "updatedBy": {
+      "id": "string",
+      "displayName": "string"
+    }
+  }
+}

package/src/form/form-audit/support-email-updated.json

@@ -0,0 +1,24 @@
+{
+  "schemaVersion": "string",
+  "category": "string",
+  "type": "string",
+  "createdAt": "Date",
+  "createdBy": {
+    "id": "string",
+    "displayName": "string"
+  },
+  "data": {
+    "formId": "string",
+    "slug": "string",
+    "changes": {
+      "previous": {
+        "supportEmail": "string",
+        "responseTime": "string"
+      },
+      "new": {
+        "supportEmail": "string",
+        "responseTime": "string"
+      }
+    }
+  }
+}

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

@@ -0,0 +1,60 @@
+import {
+  type AuditEventMessageCategory,
+  type AuditEventMessageSchemaVersion,
+  type AuditEventMessageType
+} from '~/src/form/form-audit/enums.js'
+
+export interface FormMessageData {
+  formId: string
+  slug: string
+}
+
+export interface ChangesMessageData<T> {
+  previous: T
+  new: T
+}
+
+export interface FormCreatedMessageData extends FormMessageData {
+  title: string
+  organisation: string
+  teamName: string
+  teamEmail: string
+}
+
+export interface SupportEmailUpdatedMessageData extends FormMessageData {
+  changes: ChangesMessageData<{ supportEmail: string; responseTime: string }>
+}
+
+export type MessageData =
+  | FormCreatedMessageData
+  | SupportEmailUpdatedMessageData
+
+export interface BaseMessage {
+  schemaVersion: AuditEventMessageSchemaVersion
+  category: AuditEventMessageCategory
+  type: AuditEventMessageType
+  createdAt: Date
+  createdBy: {
+    id: string
+    displayName: string
+  }
+  data: MessageData
+}
+
+export interface FormCreatedMessage extends BaseMessage {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_CREATED
+  data: FormCreatedMessageData
+}
+
+export interface SupportEmailUpdatedMessage extends BaseMessage {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_SUPPORT_EMAIL_UPDATED
+  data: SupportEmailUpdatedMessageData
+}
+
+export type Message = FormCreatedMessage | SupportEmailUpdatedMessage
+
+export interface AuditEvent {
+  message: Message
+}

package/src/index.ts

@@ -18,6 +18,8 @@ export * from '~/src/form/form-manager/errors.js'
 export * from '~/src/pages/index.js'
 export * from '~/src/utils/helpers.js'
 export * from '~/src/utils/markdown.js'
+export * from '~/src/form/form-audit/index.js'
+export * from '~/src/form/form-audit/enums.js'
 
 export type * from '~/src/common/types.js'
 export type * from '~/src/common/pagination/types.js'
@@ -31,3 +33,4 @@ export type * from '~/src/form/form-submission/types.js'
 export type * from '~/src/form/form-editor/preview/types.js'
 export type * from '~/src/form/form-editor/types.js'
 export type * from '~/src/form/form-editor/macros/types.js'
+export type * from '~/src/form/form-audit/types.js'