chore: extract shared audit log query logic

packages/lib/server-only/document/audit-log-query.ts

@@ -0,0 +1,110 @@
+import type { DocumentAuditLog, Envelope, Prisma } from '@prisma/client';
+
+import { prisma } from '@documenso/prisma';
+
+import { DOCUMENT_AUDIT_LOG_TYPE } from '../../types/document-audit-logs';
+import type { FindResultResponse } from '../../types/search-params';
+import { parseDocumentAuditLogData } from '../../utils/document-audit-logs';
+
+const RECENT_ACTIVITY_EVENT_TYPES = [
+  DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_COMPLETED,
+  DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_CREATED,
+  DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_DELETED,
+  DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_OPENED,
+  DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_COMPLETED,
+  DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_REJECTED,
+  DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_SENT,
+  DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_MOVED_TO_TEAM,
+];
+
+export interface AuditLogQueryOptions {
+  envelope: Envelope;
+  page?: number;
+  perPage?: number;
+  orderBy?: {
+    column: keyof DocumentAuditLog;
+    direction: 'asc' | 'desc';
+  };
+  cursor?: string;
+  filterForRecentActivity?: boolean;
+}
+
+function buildAuditLogWhereClause(
+  envelope: Envelope,
+  filterForRecentActivity?: boolean,
+): Prisma.DocumentAuditLogWhereInput {
+  const baseWhereClause: Prisma.DocumentAuditLogWhereInput = {
+    envelopeId: envelope.id,
+  };
+
+  if (!filterForRecentActivity) {
+    return baseWhereClause;
+  }
+
+  const recentActivityConditions: Prisma.DocumentAuditLogWhereInput['OR'] = [
+    {
+      type: {
+        in: RECENT_ACTIVITY_EVENT_TYPES,
+      },
+    },
+    {
+      type: DOCUMENT_AUDIT_LOG_TYPE.EMAIL_SENT,
+      data: {
+        path: ['isResending'],
+        equals: true,
+      },
+    },
+  ];
+
+  return {
+    ...baseWhereClause,
+    OR: recentActivityConditions,
+  };
+}
+
+export async function queryAuditLogs({
+  envelope,
+  page = 1,
+  perPage = 30,
+  orderBy,
+  cursor,
+  filterForRecentActivity,
+}: AuditLogQueryOptions) {
+  const orderByColumn = orderBy?.column ?? 'createdAt';
+  const orderByDirection = orderBy?.direction ?? 'desc';
+
+  const whereClause = buildAuditLogWhereClause(envelope, filterForRecentActivity);
+
+  const normalizedPage = Math.max(page, 1);
+  const skip = (normalizedPage - 1) * perPage;
+
+  const [data, count] = await Promise.all([
+    prisma.documentAuditLog.findMany({
+      where: whereClause,
+      skip,
+      take: perPage + 1,
+      orderBy: {
+        [orderByColumn]: orderByDirection,
+      },
+      cursor: cursor ? { id: cursor } : undefined,
+    }),
+    prisma.documentAuditLog.count({
+      where: whereClause,
+    }),
+  ]);
+
+  const allParsedData = data.map((auditLog) => parseDocumentAuditLogData(auditLog));
+
+  const hasNextPage = allParsedData.length > perPage;
+  const parsedData = hasNextPage ? allParsedData.slice(0, perPage) : allParsedData;
+  const nextCursor = hasNextPage ? allParsedData[perPage].id : undefined;
+
+  return {
+    data: parsedData,
+    count,
+    currentPage: normalizedPage,
+    perPage,
+    totalPages: Math.ceil(count / perPage),
+    nextCursor,
+  } satisfies FindResultResponse<typeof parsedData> & { nextCursor?: string };
+}

packages/lib/server-only/document/find-document-audit-logs.ts

@@ -1,17 +1,15 @@
-import { type DocumentAuditLog, EnvelopeType, type Prisma } from '@prisma/client';
+import type { DocumentAuditLog } from '@prisma/client';
+import { EnvelopeType } from '@prisma/client';
 
 import { prisma } from '@documenso/prisma';
 
 import { AppError, AppErrorCode } from '../../errors/app-error';
-import { DOCUMENT_AUDIT_LOG_TYPE } from '../../types/document-audit-logs';
-import type { FindResultResponse } from '../../types/search-params';
-import { parseDocumentAuditLogData } from '../../utils/document-audit-logs';
 import { getEnvelopeWhereInput } from '../envelope/get-envelope-by-id';
+import { queryAuditLogs } from './audit-log-query';
 
-export interface FindDocumentAuditLogsOptions {
+interface BaseAuditLogOptions {
   userId: number;
   teamId: number;
-  documentId: number;
   page?: number;
   perPage?: number;
   orderBy?: {
@@ -22,19 +20,24 @@ export interface FindDocumentAuditLogsOptions {
   filterForRecentActivity?: boolean;
 }
 
+export interface FindDocumentAuditLogsOptions extends BaseAuditLogOptions {
+  documentId: number;
+}
+
+export interface FindEnvelopeAuditLogsOptions extends BaseAuditLogOptions {
+  envelopeId: string;
+}
+
 export const findDocumentAuditLogs = async ({
   userId,
   teamId,
   documentId,
-  page = 1,
-  perPage = 30,
+  page,
+  perPage,
   orderBy,
   cursor,
   filterForRecentActivity,
 }: FindDocumentAuditLogsOptions) => {
-  const orderByColumn = orderBy?.column ?? 'createdAt';
-  const orderByDirection = orderBy?.direction ?? 'desc';
-
   const { envelopeWhereInput } = await getEnvelopeWhereInput({
     id: {
       type: 'documentId',
@@ -53,67 +56,53 @@ export const findDocumentAuditLogs = async ({
     throw new AppError(AppErrorCode.NOT_FOUND);
   }
 
-  const whereClause: Prisma.DocumentAuditLogWhereInput = {
-    envelopeId: envelope.id,
-  };
-
-  // Filter events down to what we consider recent activity.
-  if (filterForRecentActivity) {
-    whereClause.OR = [
-      {
-        type: {
-          in: [
-            DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_COMPLETED,
-            DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_CREATED,
-            DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_DELETED,
-            DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_OPENED,
-            DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_COMPLETED,
-            DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_REJECTED,
-            DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_SENT,
-            DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_MOVED_TO_TEAM,
-          ],
-        },
-      },
-      {
-        type: DOCUMENT_AUDIT_LOG_TYPE.EMAIL_SENT,
-        data: {
-          path: ['isResending'],
-          equals: true,
-        },
-      },
-    ];
-  }
-
-  const [data, count] = await Promise.all([
-    prisma.documentAuditLog.findMany({
-      where: whereClause,
-      skip: Math.max(page - 1, 0) * perPage,
-      take: perPage + 1,
-      orderBy: {
-        [orderByColumn]: orderByDirection,
-      },
-      cursor: cursor ? { id: cursor } : undefined,
-    }),
-    prisma.documentAuditLog.count({
-      where: whereClause,
-    }),
-  ]);
-
-  let nextCursor: string | undefined = undefined;
-
-  const parsedData = data.map((auditLog) => parseDocumentAuditLogData(auditLog));
-
-  if (parsedData.length > perPage) {
-    const nextItem = parsedData.pop();
-    nextCursor = nextItem!.id;
-  }
-
-  return {
-    data: parsedData,
-    count,
-    currentPage: Math.max(page, 1),
+  return queryAuditLogs({
+    envelope,
+    page,
     perPage,
-    totalPages: Math.ceil(count / perPage),
-    nextCursor,
-  } satisfies FindResultResponse<typeof parsedData> & { nextCursor?: string };
+    orderBy,
+    cursor,
+    filterForRecentActivity,
+  });
+};
+
+export const findEnvelopeAuditLogs = async ({
+  userId,
+  teamId,
+  envelopeId,
+  page,
+  perPage,
+  orderBy,
+  cursor,
+  filterForRecentActivity,
+}: FindEnvelopeAuditLogsOptions) => {
+  const isLegacyDocumentId = /^\d+$/.test(envelopeId);
+
+  const idConfig = isLegacyDocumentId
+    ? { type: 'documentId' as const, id: Number(envelopeId) }
+    : { type: 'envelopeId' as const, id: envelopeId };
+
+  const { envelopeWhereInput } = await getEnvelopeWhereInput({
+    id: idConfig,
+    type: isLegacyDocumentId ? EnvelopeType.DOCUMENT : null,
+    userId,
+    teamId,
+  });
+
+  const envelope = await prisma.envelope.findUnique({
+    where: envelopeWhereInput,
+  });
+
+  if (!envelope) {
+    throw new AppError(AppErrorCode.NOT_FOUND);
+  }
+
+  return queryAuditLogs({
+    envelope,
+    page,
+    perPage,
+    orderBy,
+    cursor,
+    filterForRecentActivity,
+  });
 };

packages/trpc/server/document-router/find-document-audit-logs.ts

@@ -10,32 +10,18 @@ export const findDocumentAuditLogsRoute = authenticatedProcedure
   .input(ZFindDocumentAuditLogsRequestSchema)
   .output(ZFindDocumentAuditLogsResponseSchema)
   .query(async ({ input, ctx }) => {
-    const { teamId } = ctx;
-
-    const {
-      page,
-      perPage,
-      documentId,
-      cursor,
-      filterForRecentActivity,
-      orderByColumn,
-      orderByDirection,
-    } = input;
+    const { orderByColumn, orderByDirection, ...auditLogParams } = input;
 
     ctx.logger.info({
       input: {
-        documentId,
+        documentId: input.documentId,
       },
     });
 
     return await findDocumentAuditLogs({
+      ...auditLogParams,
       userId: ctx.user.id,
-      teamId,
-      page,
-      perPage,
-      documentId,
-      cursor,
-      filterForRecentActivity,
+      teamId: ctx.teamId,
       orderBy: orderByColumn ? { column: orderByColumn, direction: orderByDirection } : undefined,
     });
   });

packages/trpc/server/envelope-router/find-envelope-audit-logs.ts

@@ -0,0 +1,29 @@
+import { findEnvelopeAuditLogs } from '@documenso/lib/server-only/document/find-document-audit-logs';
+
+import { authenticatedProcedure } from '../trpc';
+import {
+  ZFindEnvelopeAuditLogsRequestSchema,
+  ZFindEnvelopeAuditLogsResponseSchema,
+  findEnvelopeAuditLogsMeta,
+} from './find-envelope-audit-logs.types';
+
+export const findEnvelopeAuditLogsRoute = authenticatedProcedure
+  .meta(findEnvelopeAuditLogsMeta)
+  .input(ZFindEnvelopeAuditLogsRequestSchema)
+  .output(ZFindEnvelopeAuditLogsResponseSchema)
+  .query(async ({ input, ctx }) => {
+    const { orderByColumn, orderByDirection, ...auditLogParams } = input;
+
+    ctx.logger.info({
+      input: {
+        envelopeId: input.envelopeId,
+      },
+    });
+
+    return await findEnvelopeAuditLogs({
+      ...auditLogParams,
+      userId: ctx.user.id,
+      teamId: ctx.teamId,
+      orderBy: orderByColumn ? { column: orderByColumn, direction: orderByDirection } : undefined,
+    });
+  });

packages/trpc/server/envelope-router/find-envelope-audit-logs.types.ts

@@ -0,0 +1,35 @@
+import { z } from 'zod';
+
+import { ZDocumentAuditLogSchema } from '@documenso/lib/types/document-audit-logs';
+import { ZFindResultResponse, ZFindSearchParamsSchema } from '@documenso/lib/types/search-params';
+
+import type { TrpcRouteMeta } from '../trpc';
+
+export const findEnvelopeAuditLogsMeta: TrpcRouteMeta = {
+  openapi: {
+    method: 'GET',
+    path: '/envelope/{envelopeId}/audit-log',
+    summary: 'Get envelope audit logs',
+    description:
+      'Returns paginated audit logs for an envelope given an ID. Accepts both envelope IDs (string) and legacy document IDs (number).',
+    tags: ['Envelope'],
+  },
+};
+
+export const ZFindEnvelopeAuditLogsRequestSchema = ZFindSearchParamsSchema.extend({
+  envelopeId: z
+    .string()
+    .describe('Envelope ID (e.g., envelope_xxx) or legacy document ID (e.g., 12345)'),
+  cursor: z.string().optional(),
+  filterForRecentActivity: z.boolean().optional(),
+  orderByColumn: z.enum(['createdAt', 'type']).optional(),
+  orderByDirection: z.enum(['asc', 'desc']).default('desc'),
+});
+
+export const ZFindEnvelopeAuditLogsResponseSchema = ZFindResultResponse.extend({
+  data: ZDocumentAuditLogSchema.array(),
+  nextCursor: z.string().optional(),
+});
+
+export type TFindEnvelopeAuditLogsRequest = z.infer<typeof ZFindEnvelopeAuditLogsRequestSchema>;
+export type TFindEnvelopeAuditLogsResponse = z.infer<typeof ZFindEnvelopeAuditLogsResponseSchema>;

packages/trpc/server/envelope-router/router.ts

@@ -18,6 +18,7 @@ import { createEnvelopeRecipientsRoute } from './envelope-recipients/create-enve
 import { deleteEnvelopeRecipientRoute } from './envelope-recipients/delete-envelope-recipient';
 import { getEnvelopeRecipientRoute } from './envelope-recipients/get-envelope-recipient';
 import { updateEnvelopeRecipientsRoute } from './envelope-recipients/update-envelope-recipients';
+import { findEnvelopeAuditLogsRoute } from './find-envelope-audit-logs';
 import { getEnvelopeRoute } from './get-envelope';
 import { getEnvelopeItemsRoute } from './get-envelope-items';
 import { getEnvelopeItemsByTokenRoute } from './get-envelope-items-by-token';
@@ -65,6 +66,9 @@ export const envelopeRouter = router({
     set: setEnvelopeFieldsRoute,
     sign: signEnvelopeFieldRoute,
   },
+  auditLog: {
+    find: findEnvelopeAuditLogsRoute,
+  },
   get: getEnvelopeRoute,
   create: createEnvelopeRoute,
   use: useEnvelopeRoute,