fix: refactor search routes (#1529)

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

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(),
 });