fix: refactor search routes (#1529)

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

apps/web/src/app/(dashboard)/admin/documents/document-results.tsx

@@ -40,7 +40,7 @@ export const AdminDocumentResults = () => {
   const { data: findDocumentsData, isLoading: isFindDocumentsLoading } =
     trpc.admin.findDocuments.useQuery(
       {
-        term: debouncedTerm,
+        query: debouncedTerm,
         page: page || 1,
         perPage: perPage || 20,
       },

apps/web/src/app/(dashboard)/documents/[id]/logs/document-logs-data-table.tsx

@@ -11,7 +11,7 @@ import type { DateTimeFormatOptions } from 'luxon';
 import { UAParser } from 'ua-parser-js';
 
 import { useUpdateSearchParams } from '@documenso/lib/client-only/hooks/use-update-search-params';
-import { ZBaseTableSearchParamsSchema } from '@documenso/lib/types/search-params';
+import { ZUrlSearchParamsSchema } from '@documenso/lib/types/search-params';
 import { formatDocumentAuditLogAction } from '@documenso/lib/utils/document-audit-logs';
 import { trpc } from '@documenso/trpc/react';
 import type { DataTableColumnDef } from '@documenso/ui/primitives/data-table';
@@ -35,9 +35,7 @@ export const DocumentLogsDataTable = ({ documentId }: DocumentLogsDataTableProps
   const searchParams = useSearchParams();
   const updateSearchParams = useUpdateSearchParams();
 
-  const parsedSearchParams = ZBaseTableSearchParamsSchema.parse(
-    Object.fromEntries(searchParams ?? []),
-  );
+  const parsedSearchParams = ZUrlSearchParamsSchema.parse(Object.fromEntries(searchParams ?? []));
 
   const { data, isLoading, isInitialLoading, isLoadingError } =
     trpc.document.findDocumentAuditLogs.useQuery(

apps/web/src/app/(dashboard)/documents/data-table.tsx

@@ -9,7 +9,7 @@ import { DateTime } from 'luxon';
 import { useSession } from 'next-auth/react';
 
 import { useUpdateSearchParams } from '@documenso/lib/client-only/hooks/use-update-search-params';
-import type { FindResultSet } from '@documenso/lib/types/find-result-set';
+import type { FindResultResponse } from '@documenso/lib/types/search-params';
 import type { Document, Recipient, Team, User } from '@documenso/prisma/client';
 import { ExtendedDocumentStatus } from '@documenso/prisma/types/extended-document-status';
 import type { DataTableColumnDef } from '@documenso/ui/primitives/data-table';
@@ -24,7 +24,7 @@ import { DataTableActionDropdown } from './data-table-action-dropdown';
 import { DataTableTitle } from './data-table-title';
 
 export type DocumentsDataTableProps = {
-  results: FindResultSet<
+  results: FindResultResponse<
     Document & {
       Recipient: Recipient[];
       User: Pick<User, 'id' | 'name' | 'email'>;

apps/web/src/app/(dashboard)/documents/documents-page-view.tsx

@@ -83,7 +83,7 @@ export const DocumentsPageView = async ({ searchParams = {}, team }: DocumentsPa
     perPage,
     period,
     senderIds,
-    search,
+    query: search,
   });
 
   const getTabHref = (value: typeof status) => {

apps/web/src/app/(dashboard)/settings/public-profile/public-profile-page-view.tsx

@@ -75,7 +75,7 @@ export const PublicProfilePageView = ({ user, team, profile }: PublicProfilePage
 
   const enabledPrivateDirectTemplates = useMemo(
     () =>
-      (data?.templates ?? []).filter(
+      (data?.data ?? []).filter(
         (template): template is DirectTemplate =>
           template.directLink?.enabled === true && template.type !== TemplateType.PUBLIC,
       ),

apps/web/src/app/(dashboard)/settings/public-profile/public-templates-data-table.tsx

@@ -52,7 +52,7 @@ export const PublicTemplatesDataTable = () => {
   );
 
   const { directTemplates, publicDirectTemplates, privateDirectTemplates } = useMemo(() => {
-    const directTemplates = (data?.templates ?? []).filter(
+    const directTemplates = (data?.data ?? []).filter(
       (template): template is DirectTemplate => template.directLink?.enabled === true,
     );
 

apps/web/src/app/(dashboard)/settings/security/activity/user-security-activity-data-table.tsx

@@ -12,7 +12,7 @@ import { UAParser } from 'ua-parser-js';
 
 import { useUpdateSearchParams } from '@documenso/lib/client-only/hooks/use-update-search-params';
 import { USER_SECURITY_AUDIT_LOG_MAP } from '@documenso/lib/constants/auth';
-import { ZBaseTableSearchParamsSchema } from '@documenso/lib/types/search-params';
+import { ZUrlSearchParamsSchema } from '@documenso/lib/types/search-params';
 import { trpc } from '@documenso/trpc/react';
 import type { DataTableColumnDef } from '@documenso/ui/primitives/data-table';
 import { DataTable } from '@documenso/ui/primitives/data-table';
@@ -33,9 +33,7 @@ export const UserSecurityActivityDataTable = () => {
   const searchParams = useSearchParams();
   const updateSearchParams = useUpdateSearchParams();
 
-  const parsedSearchParams = ZBaseTableSearchParamsSchema.parse(
-    Object.fromEntries(searchParams ?? []),
-  );
+  const parsedSearchParams = ZUrlSearchParamsSchema.parse(Object.fromEntries(searchParams ?? []));
 
   const { data, isLoading, isInitialLoading, isLoadingError } =
     trpc.profile.findUserSecurityAuditLogs.useQuery(

apps/web/src/app/(dashboard)/settings/security/passkeys/user-passkeys-data-table.tsx

@@ -9,7 +9,7 @@ import { useLingui } from '@lingui/react';
 import { DateTime } from 'luxon';
 
 import { useUpdateSearchParams } from '@documenso/lib/client-only/hooks/use-update-search-params';
-import { ZBaseTableSearchParamsSchema } from '@documenso/lib/types/search-params';
+import { ZUrlSearchParamsSchema } from '@documenso/lib/types/search-params';
 import { trpc } from '@documenso/trpc/react';
 import type { DataTableColumnDef } from '@documenso/ui/primitives/data-table';
 import { DataTable } from '@documenso/ui/primitives/data-table';
@@ -27,9 +27,7 @@ export const UserPasskeysDataTable = () => {
   const searchParams = useSearchParams();
   const updateSearchParams = useUpdateSearchParams();
 
-  const parsedSearchParams = ZBaseTableSearchParamsSchema.parse(
-    Object.fromEntries(searchParams ?? []),
-  );
+  const parsedSearchParams = ZUrlSearchParamsSchema.parse(Object.fromEntries(searchParams ?? []));
 
   const { data, isLoading, isInitialLoading, isLoadingError } = trpc.auth.findPasskeys.useQuery(
     {

apps/web/src/app/(dashboard)/templates/[id]/template-page-view-documents-table.tsx

@@ -12,7 +12,7 @@ import { DateTime } from 'luxon';
 import { z } from 'zod';
 
 import { useUpdateSearchParams } from '@documenso/lib/client-only/hooks/use-update-search-params';
-import { ZBaseTableSearchParamsSchema } from '@documenso/lib/types/search-params';
+import { ZUrlSearchParamsSchema } from '@documenso/lib/types/search-params';
 import type { Team } from '@documenso/prisma/client';
 import { DocumentSource, DocumentStatus as DocumentStatusEnum } from '@documenso/prisma/client';
 import { trpc } from '@documenso/trpc/react';
@@ -40,7 +40,7 @@ const DOCUMENT_SOURCE_LABELS: { [key in DocumentSource]: MessageDescriptor } = {
   TEMPLATE_DIRECT_LINK: msg`Direct link`,
 };
 
-const ZTemplateSearchParamsSchema = ZBaseTableSearchParamsSchema.extend({
+const ZDocumentSearchParamsSchema = ZUrlSearchParamsSchema.extend({
   source: z
     .nativeEnum(DocumentSource)
     .optional()
@@ -49,10 +49,6 @@ const ZTemplateSearchParamsSchema = ZBaseTableSearchParamsSchema.extend({
     .nativeEnum(DocumentStatusEnum)
     .optional()
     .catch(() => undefined),
-  search: z.coerce
-    .string()
-    .optional()
-    .catch(() => undefined),
 });
 
 type TemplatePageViewDocumentsTableProps = {
@@ -69,7 +65,7 @@ export const TemplatePageViewDocumentsTable = ({
   const searchParams = useSearchParams();
   const updateSearchParams = useUpdateSearchParams();
 
-  const parsedSearchParams = ZTemplateSearchParamsSchema.parse(
+  const parsedSearchParams = ZDocumentSearchParamsSchema.parse(
     Object.fromEntries(searchParams ?? []),
   );
 
@@ -80,7 +76,7 @@ export const TemplatePageViewDocumentsTable = ({
         teamId: team?.id,
         page: parsedSearchParams.page,
         perPage: parsedSearchParams.perPage,
-        search: parsedSearchParams.search,
+        query: parsedSearchParams.query,
         source: parsedSearchParams.source,
         status: parsedSearchParams.status,
       },

apps/web/src/app/(dashboard)/templates/templates-page-view.tsx

@@ -29,7 +29,7 @@ export const TemplatesPageView = async ({ searchParams = {}, team }: TemplatesPa
   const documentRootPath = formatDocumentsPath(team?.url);
   const templateRootPath = formatTemplatesPath(team?.url);
 
-  const { templates, totalPages } = await findTemplates({
+  const { data: templates, totalPages } = await findTemplates({
     userId: user.id,
     teamId: team?.id,
     page: page,

apps/web/src/components/(teams)/tables/current-user-teams-data-table.tsx

@@ -11,7 +11,7 @@ import { useLingui } from '@lingui/react';
 import { useUpdateSearchParams } from '@documenso/lib/client-only/hooks/use-update-search-params';
 import { NEXT_PUBLIC_WEBAPP_URL, WEBAPP_BASE_URL } from '@documenso/lib/constants/app';
 import { TEAM_MEMBER_ROLE_MAP } from '@documenso/lib/constants/teams';
-import { ZBaseTableSearchParamsSchema } from '@documenso/lib/types/search-params';
+import { ZUrlSearchParamsSchema } from '@documenso/lib/types/search-params';
 import { canExecuteTeamAction } from '@documenso/lib/utils/teams';
 import { trpc } from '@documenso/trpc/react';
 import { AvatarWithText } from '@documenso/ui/primitives/avatar';
@@ -30,13 +30,11 @@ export const CurrentUserTeamsDataTable = () => {
   const searchParams = useSearchParams();
   const updateSearchParams = useUpdateSearchParams();
 
-  const parsedSearchParams = ZBaseTableSearchParamsSchema.parse(
-    Object.fromEntries(searchParams ?? []),
-  );
+  const parsedSearchParams = ZUrlSearchParamsSchema.parse(Object.fromEntries(searchParams ?? []));
 
   const { data, isLoading, isInitialLoading, isLoadingError } = trpc.team.findTeams.useQuery(
     {
-      term: parsedSearchParams.query,
+      query: parsedSearchParams.query,
       page: parsedSearchParams.page,
       perPage: parsedSearchParams.perPage,
     },

apps/web/src/components/(teams)/tables/pending-user-teams-data-table.tsx

@@ -9,7 +9,7 @@ import { useLingui } from '@lingui/react';
 
 import { useUpdateSearchParams } from '@documenso/lib/client-only/hooks/use-update-search-params';
 import { WEBAPP_BASE_URL } from '@documenso/lib/constants/app';
-import { ZBaseTableSearchParamsSchema } from '@documenso/lib/types/search-params';
+import { ZUrlSearchParamsSchema } from '@documenso/lib/types/search-params';
 import { trpc } from '@documenso/trpc/react';
 import { AvatarWithText } from '@documenso/ui/primitives/avatar';
 import type { DataTableColumnDef } from '@documenso/ui/primitives/data-table';
@@ -27,15 +27,13 @@ export const PendingUserTeamsDataTable = () => {
   const searchParams = useSearchParams();
   const updateSearchParams = useUpdateSearchParams();
 
-  const parsedSearchParams = ZBaseTableSearchParamsSchema.parse(
-    Object.fromEntries(searchParams ?? []),
-  );
+  const parsedSearchParams = ZUrlSearchParamsSchema.parse(Object.fromEntries(searchParams ?? []));
 
   const [checkoutPendingTeamId, setCheckoutPendingTeamId] = useState<number | null>(null);
 
   const { data, isLoading, isInitialLoading, isLoadingError } = trpc.team.findTeamsPending.useQuery(
     {
-      term: parsedSearchParams.query,
+      query: parsedSearchParams.query,
       page: parsedSearchParams.page,
       perPage: parsedSearchParams.perPage,
     },

apps/web/src/components/(teams)/tables/team-member-invites-data-table.tsx

@@ -10,7 +10,7 @@ import { History, MoreHorizontal, Trash2 } from 'lucide-react';
 
 import { useUpdateSearchParams } from '@documenso/lib/client-only/hooks/use-update-search-params';
 import { TEAM_MEMBER_ROLE_MAP } from '@documenso/lib/constants/teams';
-import { ZBaseTableSearchParamsSchema } from '@documenso/lib/types/search-params';
+import { ZUrlSearchParamsSchema } from '@documenso/lib/types/search-params';
 import { trpc } from '@documenso/trpc/react';
 import { AvatarWithText } from '@documenso/ui/primitives/avatar';
 import type { DataTableColumnDef } from '@documenso/ui/primitives/data-table';
@@ -38,15 +38,13 @@ export const TeamMemberInvitesDataTable = ({ teamId }: TeamMemberInvitesDataTabl
   const { _, i18n } = useLingui();
   const { toast } = useToast();
 
-  const parsedSearchParams = ZBaseTableSearchParamsSchema.parse(
-    Object.fromEntries(searchParams ?? []),
-  );
+  const parsedSearchParams = ZUrlSearchParamsSchema.parse(Object.fromEntries(searchParams ?? []));
 
   const { data, isLoading, isInitialLoading, isLoadingError } =
     trpc.team.findTeamMemberInvites.useQuery(
       {
         teamId,
-        term: parsedSearchParams.query,
+        query: parsedSearchParams.query,
         page: parsedSearchParams.page,
         perPage: parsedSearchParams.perPage,
       },

apps/web/src/components/(teams)/tables/team-members-data-table.tsx

@@ -10,7 +10,7 @@ import { Edit, MoreHorizontal, Trash2 } from 'lucide-react';
 
 import { useUpdateSearchParams } from '@documenso/lib/client-only/hooks/use-update-search-params';
 import { TEAM_MEMBER_ROLE_MAP } from '@documenso/lib/constants/teams';
-import { ZBaseTableSearchParamsSchema } from '@documenso/lib/types/search-params';
+import { ZUrlSearchParamsSchema } from '@documenso/lib/types/search-params';
 import { extractInitials } from '@documenso/lib/utils/recipient-formatter';
 import { isTeamRoleWithinUserHierarchy } from '@documenso/lib/utils/teams';
 import type { TeamMemberRole } from '@documenso/prisma/client';
@@ -50,14 +50,12 @@ export const TeamMembersDataTable = ({
   const searchParams = useSearchParams();
   const updateSearchParams = useUpdateSearchParams();
 
-  const parsedSearchParams = ZBaseTableSearchParamsSchema.parse(
-    Object.fromEntries(searchParams ?? []),
-  );
+  const parsedSearchParams = ZUrlSearchParamsSchema.parse(Object.fromEntries(searchParams ?? []));
 
   const { data, isLoading, isInitialLoading, isLoadingError } = trpc.team.findTeamMembers.useQuery(
     {
       teamId,
-      term: parsedSearchParams.query,
+      query: parsedSearchParams.query,
       page: parsedSearchParams.page,
       perPage: parsedSearchParams.perPage,
     },

packages/api/v1/implementation.ts

@@ -427,7 +427,7 @@ export const ApiContractV1Implementation = createNextRoute(ApiContractV1, {
     const perPage = Number(args.query.perPage) || 10;
 
     try {
-      const { templates, totalPages } = await findTemplates({
+      const { data: templates, totalPages } = await findTemplates({
         page,
         perPage,
         userId: user.id,

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>;
 };

packages/lib/types/find-result-set.ts

@@ -1,18 +0,0 @@
-import { z } from 'zod';
-
-export const ZFindResultSet = z.object({
-  data: z.union([z.array(z.unknown()), z.unknown()]),
-  count: z.number(),
-  currentPage: z.number(),
-  perPage: z.number(),
-  totalPages: z.number(),
-});
-
-// Can't infer generics from Zod.
-export type FindResultSet<T> = {
-  data: T extends Array<unknown> ? T : T[];
-  count: number;
-  currentPage: number;
-  perPage: number;
-  totalPages: number;
-};

packages/lib/types/search-params.ts

@@ -1,6 +1,24 @@
 import { z } from 'zod';
 
-export const ZBaseTableSearchParamsSchema = z.object({
+/**
+ * Backend only schema is used for find search params.
+ *
+ * Does not catch, because TRPC Open API won't allow catches as a type.
+ *
+ * Keep this and `ZUrlSearchParamsSchema` in sync.
+ */
+export const ZFindSearchParamsSchema = z.object({
+  query: z.string().optional(),
+  page: z.coerce.number().min(1).optional(),
+  perPage: z.coerce.number().min(1).optional(),
+});
+
+/**
+ * Frontend schema used to parse search params from URL.
+ *
+ * Keep this and `ZFindSearchParamsSchema` in sync.
+ */
+export const ZUrlSearchParamsSchema = z.object({
   query: z
     .string()
     .optional()
@@ -17,4 +35,19 @@ export const ZBaseTableSearchParamsSchema = z.object({
     .catch(() => undefined),
 });
 
-export type TBaseTableSearchParamsSchema = z.infer<typeof ZBaseTableSearchParamsSchema>;
+export const ZFindResultResponse = z.object({
+  data: z.union([z.array(z.unknown()), z.unknown()]),
+  count: z.number(),
+  currentPage: z.number(),
+  perPage: z.number(),
+  totalPages: z.number(),
+});
+
+// Can't infer generics from Zod.
+export type FindResultResponse<T> = {
+  data: T extends Array<unknown> ? T : T[];
+  count: number;
+  currentPage: number;
+  perPage: number;
+  totalPages: number;
+};

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

@@ -24,9 +24,9 @@ import {
 
 export const adminRouter = router({
   findDocuments: adminProcedure.input(ZAdminFindDocumentsQuerySchema).query(async ({ input }) => {
-    const { term, page, perPage } = input;
+    const { query, page, perPage } = input;
 
-    return await findDocuments({ term, page, perPage });
+    return await findDocuments({ query, page, perPage });
   }),
 
   updateUser: adminProcedure

packages/trpc/server/admin-router/schema.ts

@@ -2,10 +2,9 @@ import { Role } from '@prisma/client';
 import z from 'zod';
 
 import { ZSiteSettingSchema } from '@documenso/lib/server-only/site-settings/schema';
+import { ZFindSearchParamsSchema } from '@documenso/lib/types/search-params';
 
-export const ZAdminFindDocumentsQuerySchema = z.object({
-  term: z.string().optional(),
-  page: z.number().optional().default(1),
+export const ZAdminFindDocumentsQuerySchema = ZFindSearchParamsSchema.extend({
   perPage: z.number().optional().default(20),
 });
 

packages/trpc/server/auth-router/schema.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 
-import { ZBaseTableSearchParamsSchema } from '@documenso/lib/types/search-params';
+import { ZFindSearchParamsSchema } from '@documenso/lib/types/search-params';
 import { ZRegistrationResponseJSONSchema } from '@documenso/lib/types/webauthn';
 
 export const ZCurrentPasswordSchema = z
@@ -55,7 +55,7 @@ export const ZUpdatePasskeyMutationSchema = z.object({
   name: z.string().trim().min(1),
 });
 
-export const ZFindPasskeysQuerySchema = ZBaseTableSearchParamsSchema.extend({
+export const ZFindPasskeysQuerySchema = ZFindSearchParamsSchema.extend({
   orderBy: z
     .object({
       column: z.enum(['createdAt', 'updatedAt', 'name']),

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

@@ -86,13 +86,13 @@ export const documentRouter = router({
     .query(async ({ input, ctx }) => {
       const { user } = ctx;
 
-      const { search, teamId, templateId, page, perPage, orderBy, source, status } = input;
+      const { query, teamId, templateId, page, perPage, orderBy, source, status } = input;
 
       const documents = await findDocuments({
         userId: user.id,
         teamId,
         templateId,
-        search,
+        query,
         source,
         status,
         page,

packages/trpc/server/document-router/schema.ts

@@ -6,7 +6,7 @@ import {
   ZDocumentActionAuthTypesSchema,
 } from '@documenso/lib/types/document-auth';
 import { ZDocumentEmailSettingsSchema } from '@documenso/lib/types/document-email';
-import { ZBaseTableSearchParamsSchema } from '@documenso/lib/types/search-params';
+import { ZFindSearchParamsSchema } from '@documenso/lib/types/search-params';
 import { isValidRedirectUrl } from '@documenso/lib/utils/is-valid-redirect-url';
 import {
   DocumentDistributionMethod,
@@ -18,13 +18,9 @@ import {
   RecipientRole,
 } from '@documenso/prisma/client';
 
-export const ZFindDocumentsQuerySchema = ZBaseTableSearchParamsSchema.extend({
+export const ZFindDocumentsQuerySchema = ZFindSearchParamsSchema.extend({
   teamId: z.number().min(1).optional(),
   templateId: z.number().min(1).optional(),
-  search: z
-    .string()
-    .optional()
-    .catch(() => undefined),
   source: z.nativeEnum(DocumentSource).optional(),
   status: z.nativeEnum(DocumentStatus).optional(),
   orderBy: z
@@ -33,9 +29,9 @@ export const ZFindDocumentsQuerySchema = ZBaseTableSearchParamsSchema.extend({
       direction: z.enum(['asc', 'desc']),
     })
     .optional(),
-}).omit({ query: true });
+});
 
-export const ZFindDocumentAuditLogsQuerySchema = ZBaseTableSearchParamsSchema.extend({
+export const ZFindDocumentAuditLogsQuerySchema = ZFindSearchParamsSchema.extend({
   documentId: z.number().min(1),
   cursor: z.string().optional(),
   filterForRecentActivity: z.boolean().optional(),

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

@@ -74,20 +74,28 @@ import {
 } from './schema';
 
 export const teamRouter = router({
-  getTeams: authenticatedProcedure
+  // Internal endpoint for now.
+  getTeams: authenticatedProcedure.query(async ({ ctx }) => {
+    return await getTeams({ userId: ctx.user.id });
+  }),
+
+  findTeams: authenticatedProcedure
     .meta({
       openapi: {
         method: 'GET',
         path: '/team',
-        summary: 'Get teams',
-        description: 'Returns all teams that you are a member of',
+        summary: 'Find teams',
+        description: 'Find your teams based on a search criteria',
         tags: ['Teams'],
       },
     })
-    .input(z.void())
+    .input(ZFindTeamsQuerySchema)
     .output(z.unknown())
-    .query(async ({ ctx }) => {
-      return await getTeams({ userId: ctx.user.id });
+    .query(async ({ input, ctx }) => {
+      return await findTeams({
+        userId: ctx.user.id,
+        ...input,
+      });
     }),
 
   getTeam: authenticatedProcedure
@@ -327,14 +335,6 @@ export const teamRouter = router({
       });
     }),
 
-  // Todo: Refactor, seems to be a redundant endpoint.
-  findTeams: authenticatedProcedure.input(ZFindTeamsQuerySchema).query(async ({ input, ctx }) => {
-    return await findTeams({
-      userId: ctx.user.id,
-      ...input,
-    });
-  }),
-
   // Internal endpoint for now.
   createTeamEmailVerification: authenticatedProcedure
     // .meta({

packages/trpc/server/team-router/schema.ts

@@ -2,17 +2,11 @@ import { z } from 'zod';
 
 import { SUPPORTED_LANGUAGE_CODES } from '@documenso/lib/constants/i18n';
 import { PROTECTED_TEAM_URLS } from '@documenso/lib/constants/teams';
+import { ZFindSearchParamsSchema } from '@documenso/lib/types/search-params';
 import { DocumentVisibility, TeamMemberRole } from '@documenso/prisma/client';
 
 import { ZUpdatePublicProfileMutationSchema } from '../profile-router/schema';
 
-// Consider refactoring to use ZBaseTableSearchParamsSchema.
-const GenericFindQuerySchema = z.object({
-  term: z.string().optional(),
-  page: z.number().min(1).optional(),
-  perPage: z.number().min(1).optional(),
-});
-
 /**
  * Restrict team URLs schema.
  *
@@ -122,17 +116,17 @@ export const ZFindTeamInvoicesQuerySchema = z.object({
   teamId: z.number(),
 });
 
-export const ZFindTeamMemberInvitesQuerySchema = GenericFindQuerySchema.extend({
+export const ZFindTeamMemberInvitesQuerySchema = ZFindSearchParamsSchema.extend({
   teamId: z.number(),
 });
 
-export const ZFindTeamMembersQuerySchema = GenericFindQuerySchema.extend({
+export const ZFindTeamMembersQuerySchema = ZFindSearchParamsSchema.extend({
   teamId: z.number(),
 });
 
-export const ZFindTeamsQuerySchema = GenericFindQuerySchema;
+export const ZFindTeamsQuerySchema = ZFindSearchParamsSchema;
 
-export const ZFindTeamsPendingQuerySchema = GenericFindQuerySchema;
+export const ZFindTeamsPendingQuerySchema = ZFindSearchParamsSchema;
 
 export const ZGetTeamQuerySchema = z.object({
   teamId: z.number(),

packages/trpc/server/template-router/schema.ts

@@ -6,7 +6,7 @@ import {
   ZDocumentActionAuthTypesSchema,
 } from '@documenso/lib/types/document-auth';
 import { ZDocumentEmailSettingsSchema } from '@documenso/lib/types/document-email';
-import { ZBaseTableSearchParamsSchema } from '@documenso/lib/types/search-params';
+import { ZFindSearchParamsSchema } from '@documenso/lib/types/search-params';
 import { isValidRedirectUrl } from '@documenso/lib/utils/is-valid-redirect-url';
 import {
   DocumentDistributionMethod,
@@ -125,7 +125,7 @@ export const ZSetSigningOrderForTemplateMutationSchema = z.object({
   signingOrder: z.nativeEnum(DocumentSigningOrder),
 });
 
-export const ZFindTemplatesQuerySchema = ZBaseTableSearchParamsSchema.extend({
+export const ZFindTemplatesQuerySchema = ZFindSearchParamsSchema.extend({
   teamId: z.number().optional(),
   type: z.nativeEnum(TemplateType).optional(),
 });