feat: add sequential document view logs (#1871)

## Description

Add a new document audit log to detect when the document is viewed. This
should only be visible in the document audit log page

Notes:
1. I wanted to reuse the `DOCUMENT_OPENED` event and add an additional
paramter to track sequential views, but it's not query-able
2. This will log "DOCUMENT_VIEWED" before "DOCUMENT_OPENED" but i don't
think it matters

packages/lib/server-only/document/viewed-document.ts

@@ -27,7 +27,6 @@ export const viewedDocument = async ({
   const recipient = await prisma.recipient.findFirst({
     where: {
       token,
-      readStatus: ReadStatus.NOT_OPENED,
     },
   });
 
@@ -37,6 +36,30 @@ export const viewedDocument = async ({
 
   const { documentId } = recipient;
 
+  await prisma.documentAuditLog.create({
+    data: createDocumentAuditLogData({
+      type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_VIEWED,
+      documentId,
+      user: {
+        name: recipient.name,
+        email: recipient.email,
+      },
+      requestMetadata,
+      data: {
+        recipientEmail: recipient.email,
+        recipientId: recipient.id,
+        recipientName: recipient.name,
+        recipientRole: recipient.role,
+        accessAuth: recipientAccessAuth ?? [],
+      },
+    }),
+  });
+
+  // Early return if already opened.
+  if (recipient.readStatus === ReadStatus.OPENED) {
+    return;
+  }
+
   await prisma.$transaction(async (tx) => {
     await tx.recipient.update({
       where: {

packages/lib/types/document-audit-logs.ts

@@ -33,6 +33,7 @@ export const ZDocumentAuditLogTypeSchema = z.enum([
   'DOCUMENT_GLOBAL_AUTH_ACTION_UPDATED', // When the global action authentication is updated.
   'DOCUMENT_META_UPDATED', // When the document meta data is updated.
   'DOCUMENT_OPENED', // When the document is opened by a recipient.
+  'DOCUMENT_VIEWED', // When the document is viewed by a recipient.
   'DOCUMENT_RECIPIENT_REJECTED', // When a recipient rejects the document.
   'DOCUMENT_RECIPIENT_COMPLETED', // When a recipient completes all their required tasks for the document.
   'DOCUMENT_SENT', // When the document transitions from DRAFT to PENDING.
@@ -438,6 +439,22 @@ export const ZDocumentAuditLogEventDocumentOpenedSchema = z.object({
   }),
 });
 
+/**
+ * Event: Document viewed.
+ */
+export const ZDocumentAuditLogEventDocumentViewedSchema = z.object({
+  type: z.literal(DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_VIEWED),
+  data: ZBaseRecipientDataSchema.extend({
+    accessAuth: z.preprocess((unknownValue) => {
+      if (!unknownValue) {
+        return [];
+      }
+
+      return Array.isArray(unknownValue) ? unknownValue : [unknownValue];
+    }, z.array(ZRecipientAccessAuthTypesSchema)),
+  }),
+});
+
 /**
  * Event: Document recipient completed the document (the recipient has fully actioned and completed their required steps for the document).
  */
@@ -601,6 +618,7 @@ export const ZDocumentAuditLogSchema = ZDocumentAuditLogBaseSchema.and(
     ZDocumentAuditLogEventDocumentGlobalAuthActionUpdatedSchema,
     ZDocumentAuditLogEventDocumentMetaUpdatedSchema,
     ZDocumentAuditLogEventDocumentOpenedSchema,
+    ZDocumentAuditLogEventDocumentViewedSchema,
     ZDocumentAuditLogEventDocumentRecipientCompleteSchema,
     ZDocumentAuditLogEventDocumentRecipientRejectedSchema,
     ZDocumentAuditLogEventDocumentSentSchema,

packages/lib/utils/document-audit-logs.ts

@@ -338,6 +338,10 @@ export const formatDocumentAuditLogAction = (
       anonymous: msg`Document opened`,
       identified: msg`${prefix} opened the document`,
     }))
+    .with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_VIEWED }, () => ({
+      anonymous: msg`Document viewed`,
+      identified: msg`${prefix} viewed the document`,
+    }))
     .with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_TITLE_UPDATED }, () => ({
       anonymous: msg`Document title updated`,
       identified: msg`${prefix} updated the document title`,