fix: refactor search routes (#1529)

Refactor find endpoints to be consistent in terms of input and output.
2025-11-15 17:21:41 +10:00 · 2024-12-11 19:39:50 +09:00
parent 3d7b28a92b
commit 5df1a6602e
35 changed files with 171 additions and 184 deletions
--- a/apps/web/src/app/(dashboard)/admin/documents/document-results.tsx
+++ b/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,
      },
--- a/apps/web/src/app/(dashboard)/documents/[id]/logs/document-logs-data-table.tsx
+++ b/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(
--- a/apps/web/src/app/(dashboard)/documents/data-table.tsx
+++ b/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'>;
--- a/apps/web/src/app/(dashboard)/documents/documents-page-view.tsx
+++ b/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) => {
--- a/apps/web/src/app/(dashboard)/settings/public-profile/public-profile-page-view.tsx
+++ b/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,
      ),
--- a/apps/web/src/app/(dashboard)/settings/public-profile/public-templates-data-table.tsx
+++ b/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,
    );

--- a/apps/web/src/app/(dashboard)/settings/security/activity/user-security-activity-data-table.tsx
+++ b/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(
--- a/apps/web/src/app/(dashboard)/settings/security/passkeys/user-passkeys-data-table.tsx
+++ b/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(
    {
--- a/apps/web/src/app/(dashboard)/templates/[id]/template-page-view-documents-table.tsx
+++ b/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,
      },
--- a/apps/web/src/app/(dashboard)/templates/templates-page-view.tsx
+++ b/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,
--- a/apps/web/src/components/(teams)/tables/current-user-teams-data-table.tsx
+++ b/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,
    },
--- a/apps/web/src/components/(teams)/tables/pending-user-teams-data-table.tsx
+++ b/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,
    },
--- a/apps/web/src/components/(teams)/tables/team-member-invites-data-table.tsx
+++ b/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,
      },
--- a/apps/web/src/components/(teams)/tables/team-members-data-table.tsx
+++ b/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,
    },