fix: refactor search routes (#1529)

Refactor find endpoints to be consistent in terms of input and output.

packages/lib/server-only/admin/get-all-documents.ts

@@ -1,18 +1,20 @@
 import { prisma } from '@documenso/prisma';
 import type { Prisma } from '@documenso/prisma/client';
 
+import type { FindResultResponse } from '../../types/search-params';
+
 export interface FindDocumentsOptions {
-  term?: string;
+  query?: string;
   page?: number;
   perPage?: number;
 }
 
-export const findDocuments = async ({ term, page = 1, perPage = 10 }: FindDocumentsOptions) => {
-  const termFilters: Prisma.DocumentWhereInput | undefined = !term
+export const findDocuments = async ({ query, page = 1, perPage = 10 }: FindDocumentsOptions) => {
+  const termFilters: Prisma.DocumentWhereInput | undefined = !query
     ? undefined
     : {
         title: {
-          contains: term,
+          contains: query,
           mode: 'insensitive',
         },
       };
@@ -51,5 +53,5 @@ export const findDocuments = async ({ term, page = 1, perPage = 10 }: FindDocume
     currentPage: Math.max(page, 1),
     perPage,
     totalPages: Math.ceil(count / perPage),
-  };
+  } satisfies FindResultResponse<typeof data>;
 };

packages/lib/server-only/auth/find-passkeys.ts

@@ -1,11 +1,12 @@
-import type { FindResultSet } from '@documenso/lib/types/find-result-set';
 import { prisma } from '@documenso/prisma';
 import type { Passkey } from '@documenso/prisma/client';
 import { Prisma } from '@documenso/prisma/client';
 
+import type { FindResultResponse } from '../../types/search-params';
+
 export interface FindPasskeysOptions {
   userId: number;
-  term?: string;
+  query?: string;
   page?: number;
   perPage?: number;
   orderBy?: {
@@ -17,7 +18,7 @@ export interface FindPasskeysOptions {
 
 export const findPasskeys = async ({
   userId,
-  term = '',
+  query = '',
   page = 1,
   perPage = 10,
   orderBy,
@@ -30,9 +31,9 @@ export const findPasskeys = async ({
     userId,
   };
 
-  if (term.length > 0) {
+  if (query.length > 0) {
     whereClause.name = {
-      contains: term,
+      contains: query,
       mode: Prisma.QueryMode.insensitive,
     };
   }
@@ -72,5 +73,5 @@ export const findPasskeys = async ({
     currentPage: Math.max(page, 1),
     perPage,
     totalPages: Math.ceil(count / perPage),
-  } satisfies FindResultSet<typeof data>;
+  } satisfies FindResultResponse<typeof data>;
 };

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

@@ -1,9 +1,9 @@
-import type { FindResultSet } from '@documenso/lib/types/find-result-set';
 import { prisma } from '@documenso/prisma';
-import type { DocumentAuditLog } from '@documenso/prisma/client';
-import type { Prisma } from '@documenso/prisma/client';
+import type { DocumentAuditLog, Prisma } from '@documenso/prisma/client';
 
+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';
 
 export interface FindDocumentAuditLogsOptions {
@@ -31,7 +31,7 @@ export const findDocumentAuditLogs = async ({
   const orderByColumn = orderBy?.column ?? 'createdAt';
   const orderByDirection = orderBy?.direction ?? 'desc';
 
-  const documentFilter = await prisma.document.findFirstOrThrow({
+  const document = await prisma.document.findFirst({
     where: {
       id: documentId,
       OR: [
@@ -51,6 +51,10 @@ export const findDocumentAuditLogs = async ({
     },
   });
 
+  if (!document) {
+    throw new AppError(AppErrorCode.NOT_FOUND);
+  }
+
   const whereClause: Prisma.DocumentAuditLogWhereInput = {
     documentId,
   };
@@ -113,5 +117,5 @@ export const findDocumentAuditLogs = async ({
     perPage,
     totalPages: Math.ceil(count / perPage),
     nextCursor,
-  } satisfies FindResultSet<typeof parsedData> & { nextCursor?: string };
+  } satisfies FindResultResponse<typeof parsedData> & { nextCursor?: string };
 };

packages/lib/server-only/document/find-documents.ts

@@ -1,8 +1,7 @@
 import { DateTime } from 'luxon';
-import { P, match } from 'ts-pattern';
+import { match } from 'ts-pattern';
 
 import { prisma } from '@documenso/prisma';
-import { RecipientRole, SigningStatus, TeamMemberRole } from '@documenso/prisma/client';
 import type {
   Document,
   DocumentSource,
@@ -11,10 +10,11 @@ import type {
   TeamEmail,
   User,
 } from '@documenso/prisma/client';
+import { RecipientRole, SigningStatus, TeamMemberRole } from '@documenso/prisma/client';
 import { ExtendedDocumentStatus } from '@documenso/prisma/types/extended-document-status';
 
 import { DocumentVisibility } from '../../types/document-visibility';
-import type { FindResultSet } from '../../types/find-result-set';
+import type { FindResultResponse } from '../../types/search-params';
 import { maskRecipientTokensForDocument } from '../../utils/mask-recipient-tokens-for-document';
 
 export type PeriodSelectorValue = '' | '7d' | '14d' | '30d';
@@ -22,7 +22,6 @@ export type PeriodSelectorValue = '' | '7d' | '14d' | '30d';
 export type FindDocumentsOptions = {
   userId: number;
   teamId?: number;
-  term?: string;
   templateId?: number;
   source?: DocumentSource;
   status?: ExtendedDocumentStatus;
@@ -34,13 +33,12 @@ export type FindDocumentsOptions = {
   };
   period?: PeriodSelectorValue;
   senderIds?: number[];
-  search?: string;
+  query?: string;
 };
 
 export const findDocuments = async ({
   userId,
   teamId,
-  term,
   templateId,
   source,
   status = ExtendedDocumentStatus.ALL,
@@ -49,7 +47,7 @@ export const findDocuments = async ({
   orderBy,
   period,
   senderIds,
-  search,
+  query,
 }: FindDocumentsOptions) => {
   const user = await prisma.user.findFirstOrThrow({
     where: {
@@ -87,22 +85,11 @@ export const findDocuments = async ({
   const orderByDirection = orderBy?.direction ?? 'desc';
   const teamMemberRole = team?.members[0].role ?? null;
 
-  const termFilters = match(term)
-    .with(P.string.minLength(1), () => {
-      return {
-        title: {
-          contains: term,
-          mode: 'insensitive',
-        },
-      } as const;
-    })
-    .otherwise(() => undefined);
-
   const searchFilter: Prisma.DocumentWhereInput = {
     OR: [
-      { title: { contains: search, mode: 'insensitive' } },
-      { Recipient: { some: { name: { contains: search, mode: 'insensitive' } } } },
-      { Recipient: { some: { email: { contains: search, mode: 'insensitive' } } } },
+      { title: { contains: query, mode: 'insensitive' } },
+      { Recipient: { some: { name: { contains: query, mode: 'insensitive' } } } },
+      { Recipient: { some: { email: { contains: query, mode: 'insensitive' } } } },
     ],
   };
 
@@ -209,7 +196,6 @@ export const findDocuments = async ({
   }
 
   const whereAndClause: Prisma.DocumentWhereInput['AND'] = [
-    { ...termFilters },
     { ...filters },
     { ...deletedFilter },
     { ...searchFilter },
@@ -290,7 +276,7 @@ export const findDocuments = async ({
     currentPage: Math.max(page, 1),
     perPage,
     totalPages: Math.ceil(count / perPage),
-  } satisfies FindResultSet<typeof data>;
+  } satisfies FindResultResponse<typeof data>;
 };
 
 const findDocumentsFilter = (status: ExtendedDocumentStatus, user: User) => {

packages/lib/server-only/team/find-team-member-invites.ts

@@ -7,12 +7,12 @@ import { Prisma } from '@documenso/prisma/client';
 import { TeamMemberInviteSchema } from '@documenso/prisma/generated/zod';
 
 import { TEAM_MEMBER_ROLE_PERMISSIONS_MAP } from '../../constants/teams';
-import { type FindResultSet, ZFindResultSet } from '../../types/find-result-set';
+import { type FindResultResponse, ZFindResultResponse } from '../../types/search-params';
 
 export interface FindTeamMemberInvitesOptions {
   userId: number;
   teamId: number;
-  term?: string;
+  query?: string;
   page?: number;
   perPage?: number;
   orderBy?: {
@@ -21,7 +21,7 @@ export interface FindTeamMemberInvitesOptions {
   };
 }
 
-export const ZFindTeamMemberInvitesResponseSchema = ZFindResultSet.extend({
+export const ZFindTeamMemberInvitesResponseSchema = ZFindResultResponse.extend({
   data: TeamMemberInviteSchema.pick({
     id: true,
     teamId: true,
@@ -36,7 +36,7 @@ export type TFindTeamMemberInvitesResponse = z.infer<typeof ZFindTeamMemberInvit
 export const findTeamMemberInvites = async ({
   userId,
   teamId,
-  term,
+  query,
   page = 1,
   perPage = 10,
   orderBy,
@@ -59,10 +59,10 @@ export const findTeamMemberInvites = async ({
     },
   });
 
-  const termFilters: Prisma.TeamMemberInviteWhereInput | undefined = match(term)
+  const termFilters: Prisma.TeamMemberInviteWhereInput | undefined = match(query)
     .with(P.string.minLength(1), () => ({
       email: {
-        contains: term,
+        contains: query,
         mode: Prisma.QueryMode.insensitive,
       },
     }))
@@ -101,5 +101,5 @@ export const findTeamMemberInvites = async ({
     currentPage: Math.max(page, 1),
     perPage,
     totalPages: Math.ceil(count / perPage),
-  } satisfies FindResultSet<typeof data>;
+  } satisfies FindResultResponse<typeof data>;
 };

packages/lib/server-only/team/find-team-members.ts

@@ -6,12 +6,13 @@ import type { TeamMember } from '@documenso/prisma/client';
 import { Prisma } from '@documenso/prisma/client';
 import { TeamMemberSchema, UserSchema } from '@documenso/prisma/generated/zod';
 
-import { type FindResultSet, ZFindResultSet } from '../../types/find-result-set';
+import type { FindResultResponse } from '../../types/search-params';
+import { ZFindResultResponse } from '../../types/search-params';
 
 export interface FindTeamMembersOptions {
   userId: number;
   teamId: number;
-  term?: string;
+  query?: string;
   page?: number;
   perPage?: number;
   orderBy?: {
@@ -20,7 +21,7 @@ export interface FindTeamMembersOptions {
   };
 }
 
-export const ZFindTeamMembersResponseSchema = ZFindResultSet.extend({
+export const ZFindTeamMembersResponseSchema = ZFindResultResponse.extend({
   data: TeamMemberSchema.extend({
     user: UserSchema.pick({
       name: true,
@@ -34,7 +35,7 @@ export type TFindTeamMembersResponse = z.infer<typeof ZFindTeamMembersResponseSc
 export const findTeamMembers = async ({
   userId,
   teamId,
-  term,
+  query,
   page = 1,
   perPage = 10,
   orderBy,
@@ -54,11 +55,11 @@ export const findTeamMembers = async ({
     },
   });
 
-  const termFilters: Prisma.TeamMemberWhereInput | undefined = match(term)
+  const termFilters: Prisma.TeamMemberWhereInput | undefined = match(query)
     .with(P.string.minLength(1), () => ({
       user: {
         name: {
-          contains: term,
+          contains: query,
           mode: Prisma.QueryMode.insensitive,
         },
       },
@@ -109,5 +110,5 @@ export const findTeamMembers = async ({
     currentPage: Math.max(page, 1),
     perPage,
     totalPages: Math.ceil(count / perPage),
-  } satisfies FindResultSet<typeof data>;
+  } satisfies FindResultResponse<typeof data>;
 };

packages/lib/server-only/team/find-teams-pending.ts

@@ -5,11 +5,11 @@ import type { Team } from '@documenso/prisma/client';
 import { Prisma } from '@documenso/prisma/client';
 import { TeamPendingSchema } from '@documenso/prisma/generated/zod';
 
-import { type FindResultSet, ZFindResultSet } from '../../types/find-result-set';
+import { type FindResultResponse, ZFindResultResponse } from '../../types/search-params';
 
 export interface FindTeamsPendingOptions {
   userId: number;
-  term?: string;
+  query?: string;
   page?: number;
   perPage?: number;
   orderBy?: {
@@ -18,7 +18,7 @@ export interface FindTeamsPendingOptions {
   };
 }
 
-export const ZFindTeamsPendingResponseSchema = ZFindResultSet.extend({
+export const ZFindTeamsPendingResponseSchema = ZFindResultResponse.extend({
   data: TeamPendingSchema.array(),
 });
 
@@ -26,7 +26,7 @@ export type TFindTeamsPendingResponse = z.infer<typeof ZFindTeamsPendingResponse
 
 export const findTeamsPending = async ({
   userId,
-  term,
+  query,
   page = 1,
   perPage = 10,
   orderBy,
@@ -38,9 +38,9 @@ export const findTeamsPending = async ({
     ownerUserId: userId,
   };
 
-  if (term && term.length > 0) {
+  if (query && query.length > 0) {
     whereClause.name = {
-      contains: term,
+      contains: query,
       mode: Prisma.QueryMode.insensitive,
     };
   }
@@ -65,5 +65,5 @@ export const findTeamsPending = async ({
     currentPage: Math.max(page, 1),
     perPage,
     totalPages: Math.ceil(count / perPage),
-  } satisfies FindResultSet<typeof data>;
+  } satisfies FindResultResponse<typeof data>;
 };

packages/lib/server-only/team/find-teams.ts

@@ -1,11 +1,12 @@
-import type { FindResultSet } from '@documenso/lib/types/find-result-set';
 import { prisma } from '@documenso/prisma';
 import type { Team } from '@documenso/prisma/client';
 import { Prisma } from '@documenso/prisma/client';
 
+import type { FindResultResponse } from '../../types/search-params';
+
 export interface FindTeamsOptions {
   userId: number;
-  term?: string;
+  query?: string;
   page?: number;
   perPage?: number;
   orderBy?: {
@@ -16,7 +17,7 @@ export interface FindTeamsOptions {
 
 export const findTeams = async ({
   userId,
-  term,
+  query,
   page = 1,
   perPage = 10,
   orderBy,
@@ -32,9 +33,9 @@ export const findTeams = async ({
     },
   };
 
-  if (term && term.length > 0) {
+  if (query && query.length > 0) {
     whereClause.name = {
-      contains: term,
+      contains: query,
       mode: Prisma.QueryMode.insensitive,
     };
   }
@@ -72,5 +73,5 @@ export const findTeams = async ({
     currentPage: Math.max(page, 1),
     perPage,
     totalPages: Math.ceil(count / perPage),
-  } satisfies FindResultSet<typeof maskedData>;
+  } satisfies FindResultResponse<typeof maskedData>;
 };

packages/lib/server-only/template/find-templates.ts

@@ -1,6 +1,8 @@
 import { prisma } from '@documenso/prisma';
 import type { Prisma, Template } from '@documenso/prisma/client';
 
+import type { FindResultResponse } from '../../types/search-params';
+
 export type FindTemplatesOptions = {
   userId: number;
   teamId?: number;
@@ -10,7 +12,7 @@ export type FindTemplatesOptions = {
 };
 
 export type FindTemplatesResponse = Awaited<ReturnType<typeof findTemplates>>;
-export type FindTemplateRow = FindTemplatesResponse['templates'][number];
+export type FindTemplateRow = FindTemplatesResponse['data'][number];
 
 export const findTemplates = async ({
   userId,
@@ -38,7 +40,7 @@ export const findTemplates = async ({
     };
   }
 
-  const [templates, count] = await Promise.all([
+  const [data, count] = await Promise.all([
     prisma.template.findMany({
       where: whereFilter,
       include: {
@@ -75,7 +77,10 @@ export const findTemplates = async ({
   ]);
 
   return {
-    templates,
+    data,
+    count,
+    currentPage: Math.max(page, 1),
+    perPage,
     totalPages: Math.ceil(count / perPage),
-  };
+  } satisfies FindResultResponse<typeof data>;
 };

packages/lib/server-only/user/find-user-security-audit-logs.ts

@@ -1,7 +1,8 @@
-import type { FindResultSet } from '@documenso/lib/types/find-result-set';
 import { prisma } from '@documenso/prisma';
 import type { UserSecurityAuditLog, UserSecurityAuditLogType } from '@documenso/prisma/client';
 
+import type { FindResultResponse } from '../../types/search-params';
+
 export type FindUserSecurityAuditLogsOptions = {
   userId: number;
   type?: UserSecurityAuditLogType;
@@ -48,5 +49,5 @@ export const findUserSecurityAuditLogs = async ({
     currentPage: Math.max(page, 1),
     perPage,
     totalPages: Math.ceil(count / perPage),
-  } satisfies FindResultSet<typeof data>;
+  } satisfies FindResultResponse<typeof data>;
 };