@defra/forms-model 3.0.514 → 3.0.516

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

@@ -4,7 +4,7 @@ import {
   type AuditEventMessageType
 } from '~/src/form/form-audit/enums.js'
 
-export interface FormMessageData {
+export interface FormMessageDataBase {
   formId: string
   slug: string
 }
@@ -14,47 +14,288 @@ export interface ChangesMessageData<T> {
   new: T
 }
 
-export interface FormCreatedMessageData extends FormMessageData {
+export interface FormCreatedMessageData extends FormMessageDataBase {
   title: string
   organisation: string
   teamName: string
   teamEmail: string
 }
 
-export interface SupportEmailUpdatedMessageData extends FormMessageData {
-  changes: ChangesMessageData<{ supportEmail: string; responseTime: string }>
+export interface FormTitleChanges {
+  title: string
+}
+
+export interface FormOrganisationChanges {
+  organisation: string
+}
+
+export interface FormTeamNameChanges {
+  teamName: string
+}
+
+export interface FormTeamEmailChanges {
+  teamEmail: string
+}
+
+export interface FormSupportPhoneChanges {
+  phone: string
+}
+
+export interface FormSupportEmailChanges {
+  address: string
+  responseTime: string
+}
+
+export interface FormSupportOnlineChanges {
+  url: string
+  text: string
+}
+
+export interface FormPrivacyNoticeChanges {
+  privacyNoticeUrl: string
+}
+
+export interface FormNotificationEmailChanges {
+  notificationEmail: string
+}
+
+export interface FormSubmissionGuidanceChanges {
+  submissionGuidance: string
+}
+
+export interface FormUploadedChanges {
+  value: string
+}
+
+export interface FormTitleUpdatedMessageData extends FormMessageDataBase {
+  changes: ChangesMessageData<FormTitleChanges>
+}
+
+export interface FormOrganisationUpdatedMessageData
+  extends FormMessageDataBase {
+  changes: ChangesMessageData<FormOrganisationChanges>
+}
+
+export interface FormTeamNameUpdatedMessageData extends FormMessageDataBase {
+  changes: ChangesMessageData<FormTeamNameChanges>
+}
+
+export interface FormTeamEmailUpdatedMessageData extends FormMessageDataBase {
+  changes: ChangesMessageData<FormTeamEmailChanges>
+}
+
+export interface FormSupportPhoneUpdatedMessageData
+  extends FormMessageDataBase {
+  changes: ChangesMessageData<FormSupportPhoneChanges>
 }
 
-export type MessageData =
+export interface FormSupportEmailUpdatedMessageData
+  extends FormMessageDataBase {
+  changes: ChangesMessageData<FormSupportEmailChanges>
+}
+
+export interface FormSupportOnlineUpdatedMessageData
+  extends FormMessageDataBase {
+  changes: ChangesMessageData<FormSupportOnlineChanges>
+}
+
+export interface FormPrivacyNoticeUpdatedMessageData
+  extends FormMessageDataBase {
+  changes: ChangesMessageData<FormPrivacyNoticeChanges>
+}
+
+export interface FormNotificationEmailUpdatedMessageData
+  extends FormMessageDataBase {
+  changes: ChangesMessageData<FormNotificationEmailChanges>
+}
+
+export interface FormSubmissionGuidanceUpdatedMessageData
+  extends FormMessageDataBase {
+  changes: ChangesMessageData<FormSubmissionGuidanceChanges>
+}
+
+export interface FormUploadedMessageData extends FormMessageDataBase {
+  changes: ChangesMessageData<FormUploadedChanges>
+}
+
+export type FormMessageChangesData =
+  | FormTitleUpdatedMessageData
+  | FormOrganisationUpdatedMessageData
+  | FormTeamNameUpdatedMessageData
+  | FormTeamEmailUpdatedMessageData
+  | FormSupportPhoneUpdatedMessageData
+  | FormSupportEmailUpdatedMessageData
+  | FormSupportOnlineUpdatedMessageData
+  | FormPrivacyNoticeUpdatedMessageData
+  | FormNotificationEmailUpdatedMessageData
+  | FormSubmissionGuidanceUpdatedMessageData
+  | FormUploadedMessageData
+
+export type FormMessageActivitiesData =
   | FormCreatedMessageData
-  | SupportEmailUpdatedMessageData
+  | FormUpdatedMessageData
 
-export interface BaseMessage {
+export interface FormUpdatedMessageData extends FormMessageDataBase {
+  description: string
+}
+
+export interface AuditUser {
+  id: string
+  displayName: string
+}
+
+export type MessageData = FormMessageChangesData | FormMessageActivitiesData
+
+export interface MessageBase {
   schemaVersion: AuditEventMessageSchemaVersion
   category: AuditEventMessageCategory
   type: AuditEventMessageType
+  entityId: string
   createdAt: Date
-  createdBy: {
-    id: string
-    displayName: string
-  }
-  data: MessageData
+  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 FormTitleUpdatedMessage extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_TITLE_UPDATED
+  data: FormTitleUpdatedMessageData
+}
+
+export interface FormOrganisationUpdatedMessage extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_ORGANISATION_UPDATED
+  data: FormOrganisationUpdatedMessageData
+}
+
+export interface FormTeamNameUpdatedMessage extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_TEAM_NAME_UPDATED
+  data: FormTeamNameUpdatedMessageData
+}
+
+export interface FormTeamEmailUpdatedMessage extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_TEAM_EMAIL_UPDATED
+  data: FormTeamEmailUpdatedMessageData
+}
+
+export interface FormSupportPhoneUpdatedMessage extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_SUPPORT_PHONE_UPDATED
+  data: FormSupportPhoneUpdatedMessageData
+}
+
+export interface FormSupportEmailUpdatedMessage extends MessageBase {
   category: AuditEventMessageCategory.FORM
   type: AuditEventMessageType.FORM_SUPPORT_EMAIL_UPDATED
-  data: SupportEmailUpdatedMessageData
+  data: FormSupportEmailUpdatedMessageData
 }
 
-export type Message = FormCreatedMessage | SupportEmailUpdatedMessage
+export interface FormSupportOnlineUpdatedMessage extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_SUPPORT_ONLINE_UPDATED
+  data: FormSupportOnlineUpdatedMessageData
+}
+
+export interface FormSupportPrivacyNoticeUpdatedMessage extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_PRIVACY_NOTICE_UPDATED
+  data: FormPrivacyNoticeUpdatedMessageData
+}
+
+export interface FormSupportNotificationEmailUpdatedMessage
+  extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_NOTIFICATION_EMAIL_UPDATED
+  data: FormNotificationEmailUpdatedMessageData
+}
+
+export interface FormSupportSubmissionGuidanceUpdatedMessage
+  extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_SUBMISSION_GUIDANCE_UPDATED
+  data: FormSubmissionGuidanceUpdatedMessageData
+}
+
+export interface FormUploadedMessage extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_JSON_UPLOADED
+  data: FormUploadedMessageData
+}
+
+export interface FormDownloadedMessage extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_JSON_DOWNLOADED
+}
+
+export interface FormPublishedMessage extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_PUBLISHED
+}
+
+export interface FormDraftCreatedFromLiveMessage extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_DRAFT_CREATED_FROM_LIVE
+}
+
+export interface FormLiveCreatedFromDraftMessage extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_LIVE_CREATED_FROM_DRAFT
+}
+
+export interface FormDraftDeletedMessage extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_DRAFT_DELETED
+}
+
+export interface FormMigratedMessage extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_MIGRATED
+}
+
+export interface FormUpdatedMessage extends MessageBase {
+  category: AuditEventMessageCategory.FORM
+  type: AuditEventMessageType.FORM_UPDATED
+}
+
+export type AuditMessage =
+  | FormCreatedMessage
+  | FormTitleUpdatedMessage
+  | FormOrganisationUpdatedMessage
+  | FormTeamNameUpdatedMessage
+  | FormTeamEmailUpdatedMessage
+  | FormSupportPhoneUpdatedMessage
+  | FormSupportEmailUpdatedMessage
+  | FormSupportOnlineUpdatedMessage
+  | FormSupportPrivacyNoticeUpdatedMessage
+  | FormSupportNotificationEmailUpdatedMessage
+  | FormSupportSubmissionGuidanceUpdatedMessage
+  | FormUploadedMessage
+  | FormDownloadedMessage
+  | FormPublishedMessage
+  | FormDraftCreatedFromLiveMessage
+  | FormLiveCreatedFromDraftMessage
+  | FormDraftDeletedMessage
+  | FormMigratedMessage
+  | FormUpdatedMessage
 
 export interface AuditEvent {
-  message: Message
+  message: AuditMessage
+}
+
+export type AuditRecord = AuditMessage & {
+  messageId: 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'