fix: refactor teams router (#1500)

packages/api/package.json

@@ -25,6 +25,6 @@
     "superjson": "^1.13.1",
     "swagger-ui-react": "^5.11.0",
     "ts-pattern": "^5.0.5",
-    "zod": "^3.22.4"
+    "zod": "^3.23.8"
   }
-}
+}

packages/ee/package.json

@@ -21,6 +21,6 @@
     "next-auth": "4.24.5",
     "react": "^18",
     "ts-pattern": "^5.0.5",
-    "zod": "^3.22.4"
+    "zod": "^3.23.8"
   }
-}
+}

packages/lib/package.json

@@ -56,7 +56,7 @@
     "sharp": "0.32.6",
     "stripe": "^12.7.0",
     "ts-pattern": "^5.0.5",
-    "zod": "^3.22.4"
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "@playwright/browser-chromium": "1.43.0",

packages/lib/server-only/team/create-team-email-verification.ts

@@ -31,7 +31,7 @@ export const createTeamEmailVerification = async ({
   userId,
   teamId,
   data,
-}: CreateTeamEmailVerificationOptions) => {
+}: CreateTeamEmailVerificationOptions): Promise<void> => {
   try {
     await prisma.$transaction(
       async (tx) => {

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

@@ -34,7 +34,7 @@ export const createTeamMemberInvites = async ({
   userName,
   teamId,
   invitations,
-}: CreateTeamMemberInvitesOptions) => {
+}: CreateTeamMemberInvitesOptions): Promise<void> => {
   const team = await prisma.team.findFirstOrThrow({
     where: {
       id: teamId,

packages/lib/server-only/team/create-team.ts

@@ -31,14 +31,17 @@ export type CreateTeamOptions = {
   teamUrl: string;
 };
 
-export type CreateTeamResponse =
-  | {
-      paymentRequired: false;
-    }
-  | {
-      paymentRequired: true;
-      pendingTeamId: number;
-    };
+export const ZCreateTeamResponseSchema = z.union([
+  z.object({
+    paymentRequired: z.literal(false),
+  }),
+  z.object({
+    paymentRequired: z.literal(true),
+    pendingTeamId: z.number(),
+  }),
+]);
+
+export type TCreateTeamResponse = z.infer<typeof ZCreateTeamResponseSchema>;
 
 /**
  * Create a team or pending team depending on the user's subscription or application's billing settings.
@@ -47,7 +50,7 @@ export const createTeam = async ({
   userId,
   teamName,
   teamUrl,
-}: CreateTeamOptions): Promise<CreateTeamResponse> => {
+}: CreateTeamOptions): Promise<TCreateTeamResponse> => {
   const user = await prisma.user.findUniqueOrThrow({
     where: {
       id: userId,

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

@@ -1,11 +1,13 @@
 import { P, match } from 'ts-pattern';
+import type { z } from 'zod';
 
 import { prisma } from '@documenso/prisma';
 import type { TeamMemberInvite } from '@documenso/prisma/client';
 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 } from '../../types/find-result-set';
+import { type FindResultSet, ZFindResultSet } from '../../types/find-result-set';
 
 export interface FindTeamMemberInvitesOptions {
   userId: number;
@@ -19,6 +21,18 @@ export interface FindTeamMemberInvitesOptions {
   };
 }
 
+export const ZFindTeamMemberInvitesResponseSchema = ZFindResultSet.extend({
+  data: TeamMemberInviteSchema.pick({
+    id: true,
+    teamId: true,
+    email: true,
+    role: true,
+    createdAt: true,
+  }).array(),
+});
+
+export type TFindTeamMemberInvitesResponse = z.infer<typeof ZFindTeamMemberInvitesResponseSchema>;
+
 export const findTeamMemberInvites = async ({
   userId,
   teamId,
@@ -26,7 +40,7 @@ export const findTeamMemberInvites = async ({
   page = 1,
   perPage = 10,
   orderBy,
-}: FindTeamMemberInvitesOptions) => {
+}: FindTeamMemberInvitesOptions): Promise<TFindTeamMemberInvitesResponse> => {
   const orderByColumn = orderBy?.column ?? 'email';
   const orderByDirection = orderBy?.direction ?? 'desc';
 

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

@@ -1,10 +1,12 @@
 import { P, match } from 'ts-pattern';
+import type { z } from 'zod';
 
 import { prisma } from '@documenso/prisma';
 import type { TeamMember } from '@documenso/prisma/client';
 import { Prisma } from '@documenso/prisma/client';
+import { TeamMemberSchema, UserSchema } from '@documenso/prisma/generated/zod';
 
-import type { FindResultSet } from '../../types/find-result-set';
+import { type FindResultSet, ZFindResultSet } from '../../types/find-result-set';
 
 export interface FindTeamMembersOptions {
   userId: number;
@@ -18,6 +20,17 @@ export interface FindTeamMembersOptions {
   };
 }
 
+export const ZFindTeamMembersResponseSchema = ZFindResultSet.extend({
+  data: TeamMemberSchema.extend({
+    user: UserSchema.pick({
+      name: true,
+      email: true,
+    }),
+  }).array(),
+});
+
+export type TFindTeamMembersResponse = z.infer<typeof ZFindTeamMembersResponseSchema>;
+
 export const findTeamMembers = async ({
   userId,
   teamId,
@@ -25,7 +38,7 @@ export const findTeamMembers = async ({
   page = 1,
   perPage = 10,
   orderBy,
-}: FindTeamMembersOptions) => {
+}: FindTeamMembersOptions): Promise<TFindTeamMembersResponse> => {
   const orderByColumn = orderBy?.column ?? 'name';
   const orderByDirection = orderBy?.direction ?? 'desc';
 

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

@@ -1,6 +1,11 @@
+import type { z } from 'zod';
+
 import { prisma } from '@documenso/prisma';
 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';
 
 export interface FindTeamsPendingOptions {
   userId: number;
@@ -13,13 +18,19 @@ export interface FindTeamsPendingOptions {
   };
 }
 
+export const ZFindTeamsPendingResponseSchema = ZFindResultSet.extend({
+  data: TeamPendingSchema.array(),
+});
+
+export type TFindTeamsPendingResponse = z.infer<typeof ZFindTeamsPendingResponseSchema>;
+
 export const findTeamsPending = async ({
   userId,
   term,
   page = 1,
   perPage = 10,
   orderBy,
-}: FindTeamsPendingOptions) => {
+}: FindTeamsPendingOptions): Promise<TFindTeamsPendingResponse> => {
   const orderByColumn = orderBy?.column ?? 'name';
   const orderByDirection = orderBy?.direction ?? 'desc';
 
@@ -54,5 +65,5 @@ export const findTeamsPending = async ({
     currentPage: Math.max(page, 1),
     perPage,
     totalPages: Math.ceil(count / perPage),
-  };
+  } satisfies FindResultSet<typeof data>;
 };

packages/lib/server-only/team/get-team-invitations.ts

@@ -1,10 +1,26 @@
+import type { z } from 'zod';
+
 import { prisma } from '@documenso/prisma';
+import { TeamMemberInviteSchema, TeamSchema } from '@documenso/prisma/generated/zod';
 
 export type GetTeamInvitationsOptions = {
   email: string;
 };
 
-export const getTeamInvitations = async ({ email }: GetTeamInvitationsOptions) => {
+export const ZGetTeamInvitationsResponseSchema = TeamMemberInviteSchema.extend({
+  team: TeamSchema.pick({
+    id: true,
+    name: true,
+    url: true,
+    avatarImageId: true,
+  }),
+}).array();
+
+export type TGetTeamInvitationsResponse = z.infer<typeof ZGetTeamInvitationsResponseSchema>;
+
+export const getTeamInvitations = async ({
+  email,
+}: GetTeamInvitationsOptions): Promise<TGetTeamInvitationsResponse> => {
   return await prisma.teamMemberInvite.findMany({
     where: {
       email,

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

@@ -1,14 +1,30 @@
+import type { z } from 'zod';
+
 import { prisma } from '@documenso/prisma';
+import { TeamMemberSchema, UserSchema } from '@documenso/prisma/generated/zod';
 
 export type GetTeamMembersOptions = {
   userId: number;
   teamId: number;
 };
 
+export const ZGetTeamMembersResponseSchema = TeamMemberSchema.extend({
+  user: UserSchema.pick({
+    id: true,
+    name: true,
+    email: true,
+  }),
+}).array();
+
+export type TGetTeamMembersResponseSchema = z.infer<typeof ZGetTeamMembersResponseSchema>;
+
 /**
  * Get all team members for a given team.
  */
-export const getTeamMembers = async ({ userId, teamId }: GetTeamMembersOptions) => {
+export const getTeamMembers = async ({
+  userId,
+  teamId,
+}: GetTeamMembersOptions): Promise<TGetTeamMembersResponseSchema> => {
   return await prisma.teamMember.findMany({
     where: {
       team: {

packages/lib/server-only/team/get-team.ts

@@ -1,19 +1,38 @@
+import type { z } from 'zod';
+
 import { prisma } from '@documenso/prisma';
 import type { Prisma } from '@documenso/prisma/client';
+import {
+  TeamEmailSchema,
+  TeamGlobalSettingsSchema,
+  TeamSchema,
+} from '@documenso/prisma/generated/zod';
+import { TeamMemberSchema } from '@documenso/prisma/generated/zod';
 
 export type GetTeamByIdOptions = {
   userId?: number;
   teamId: number;
 };
 
-export type GetTeamResponse = Awaited<ReturnType<typeof getTeamById>>;
+export const ZGetTeamByIdResponseSchema = TeamSchema.extend({
+  teamEmail: TeamEmailSchema.nullable(),
+  teamGlobalSettings: TeamGlobalSettingsSchema.nullable(),
+  currentTeamMember: TeamMemberSchema.pick({
+    role: true,
+  }).nullable(),
+});
+
+export type TGetTeamByIdResponse = z.infer<typeof ZGetTeamByIdResponseSchema>;
 
 /**
  * Get a team given a teamId.
  *
  * Provide an optional userId to check that the user is a member of the team.
  */
-export const getTeamById = async ({ userId, teamId }: GetTeamByIdOptions) => {
+export const getTeamById = async ({
+  userId,
+  teamId,
+}: GetTeamByIdOptions): Promise<TGetTeamByIdResponse> => {
   const whereFilter: Prisma.TeamWhereUniqueInput = {
     id: teamId,
   };

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

@@ -1,11 +1,21 @@
+import type { z } from 'zod';
+
 import { prisma } from '@documenso/prisma';
+import { TeamMemberSchema, TeamSchema } from '@documenso/prisma/generated/zod';
 
 export type GetTeamsOptions = {
   userId: number;
 };
-export type GetTeamsResponse = Awaited<ReturnType<typeof getTeams>>;
 
-export const getTeams = async ({ userId }: GetTeamsOptions) => {
+export const ZGetTeamsResponseSchema = TeamSchema.extend({
+  currentTeamMember: TeamMemberSchema.pick({
+    role: true,
+  }),
+}).array();
+
+export type TGetTeamsResponse = z.infer<typeof ZGetTeamsResponseSchema>;
+
+export const getTeams = async ({ userId }: GetTeamsOptions): Promise<TGetTeamsResponse> => {
   const teams = await prisma.team.findMany({
     where: {
       members: {

packages/lib/server-only/team/leave-team.ts

@@ -16,7 +16,7 @@ export type LeaveTeamOptions = {
   teamId: number;
 };
 
-export const leaveTeam = async ({ userId, teamId }: LeaveTeamOptions) => {
+export const leaveTeam = async ({ userId, teamId }: LeaveTeamOptions): Promise<void> => {
   await prisma.$transaction(
     async (tx) => {
       const team = await tx.team.findFirstOrThrow({

packages/lib/server-only/team/request-team-ownership-transfer.ts

@@ -44,7 +44,7 @@ export const requestTeamOwnershipTransfer = async ({
   userName,
   teamId,
   newOwnerUserId,
-}: RequestTeamOwnershipTransferOptions) => {
+}: RequestTeamOwnershipTransferOptions): Promise<void> => {
   // Todo: Clear payment methods disabled for now.
   const clearPaymentMethods = false;
 

packages/lib/server-only/team/resend-team-email-verification.ts

@@ -16,7 +16,7 @@ export type ResendTeamMemberInvitationOptions = {
 export const resendTeamEmailVerification = async ({
   userId,
   teamId,
-}: ResendTeamMemberInvitationOptions) => {
+}: ResendTeamMemberInvitationOptions): Promise<void> => {
   await prisma.$transaction(
     async (tx) => {
       const team = await tx.team.findUniqueOrThrow({

packages/lib/server-only/team/resend-team-member-invitation.ts

@@ -34,7 +34,7 @@ export const resendTeamMemberInvitation = async ({
   userName,
   teamId,
   invitationId,
-}: ResendTeamMemberInvitationOptions) => {
+}: ResendTeamMemberInvitationOptions): Promise<void> => {
   await prisma.$transaction(
     async (tx) => {
       const team = await tx.team.findUniqueOrThrow({

packages/lib/server-only/team/update-team-branding-settings.ts

@@ -1,5 +1,8 @@
+import type { z } from 'zod';
+
 import { prisma } from '@documenso/prisma';
 import { TeamMemberRole } from '@documenso/prisma/client';
+import { TeamGlobalSettingsSchema } from '@documenso/prisma/generated/zod';
 
 export type UpdateTeamBrandingSettingsOptions = {
   userId: number;
@@ -13,11 +16,17 @@ export type UpdateTeamBrandingSettingsOptions = {
   };
 };
 
+export const ZUpdateTeamBrandingSettingsResponseSchema = TeamGlobalSettingsSchema;
+
+export type TUpdateTeamBrandingSettingsResponse = z.infer<
+  typeof ZUpdateTeamBrandingSettingsResponseSchema
+>;
+
 export const updateTeamBrandingSettings = async ({
   userId,
   teamId,
   settings,
-}: UpdateTeamBrandingSettingsOptions) => {
+}: UpdateTeamBrandingSettingsOptions): Promise<TUpdateTeamBrandingSettingsResponse> => {
   const { brandingEnabled, brandingLogo, brandingUrl, brandingCompanyDetails } = settings;
 
   const member = await prisma.teamMember.findFirst({

packages/lib/server-only/team/update-team-document-settings.ts

@@ -1,6 +1,9 @@
+import type { z } from 'zod';
+
 import { prisma } from '@documenso/prisma';
 import type { DocumentVisibility } from '@documenso/prisma/client';
 import { TeamMemberRole } from '@documenso/prisma/client';
+import { TeamGlobalSettingsSchema } from '@documenso/prisma/generated/zod';
 
 import type { SupportedLanguageCodes } from '../../constants/i18n';
 
@@ -17,11 +20,17 @@ export type UpdateTeamDocumentSettingsOptions = {
   };
 };
 
+export const ZUpdateTeamDocumentSettingsResponseSchema = TeamGlobalSettingsSchema;
+
+export type TUpdateTeamDocumentSettingsResponse = z.infer<
+  typeof ZUpdateTeamDocumentSettingsResponseSchema
+>;
+
 export const updateTeamDocumentSettings = async ({
   userId,
   teamId,
   settings,
-}: UpdateTeamDocumentSettingsOptions) => {
+}: UpdateTeamDocumentSettingsOptions): Promise<TUpdateTeamDocumentSettingsResponse> => {
   const {
     documentVisibility,
     documentLanguage,

packages/lib/server-only/team/update-team-email.ts

@@ -10,7 +10,11 @@ export type UpdateTeamEmailOptions = {
   };
 };
 
-export const updateTeamEmail = async ({ userId, teamId, data }: UpdateTeamEmailOptions) => {
+export const updateTeamEmail = async ({
+  userId,
+  teamId,
+  data,
+}: UpdateTeamEmailOptions): Promise<void> => {
   await prisma.$transaction(async (tx) => {
     await tx.team.findFirstOrThrow({
       where: {

packages/lib/server-only/team/update-team-member.ts

@@ -18,7 +18,7 @@ export const updateTeamMember = async ({
   teamId,
   teamMemberId,
   data,
-}: UpdateTeamMemberOptions) => {
+}: UpdateTeamMemberOptions): Promise<void> => {
   await prisma.$transaction(async (tx) => {
     // Find the team and validate that the user is allowed to update members.
     const team = await tx.team.findFirstOrThrow({

packages/lib/server-only/team/update-team.ts

@@ -14,7 +14,7 @@ export type UpdateTeamOptions = {
   };
 };
 
-export const updateTeam = async ({ userId, teamId, data }: UpdateTeamOptions) => {
+export const updateTeam = async ({ userId, teamId, data }: UpdateTeamOptions): Promise<void> => {
   try {
     await prisma.$transaction(async (tx) => {
       const foundPendingTeamWithUrl = await tx.teamPending.findFirst({

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

@@ -1,3 +1,14 @@
+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;

packages/prisma/package.json

@@ -32,6 +32,7 @@
     "dotenv-cli": "^7.3.0",
     "prisma-kysely": "^1.8.0",
     "tsx": "^4.11.0",
-    "typescript": "5.2.2"
+    "typescript": "5.2.2",
+    "zod-prisma-types": "^3.1.8"
   }
-}
+}

packages/prisma/schema.prisma

@@ -6,6 +6,10 @@ generator client {
   provider = "prisma-client-js"
 }
 
+generator zod {
+  provider = "zod-prisma-types"
+}
+
 datasource db {
   provider  = "postgresql"
   url       = env("NEXT_PRIVATE_DATABASE_URL")

packages/trpc/package.json

@@ -22,7 +22,6 @@
     "luxon": "^3.4.0",
     "superjson": "^1.13.1",
     "ts-pattern": "^5.0.5",
-    "zod": "^3.22.4"
-  },
-  "devDependencies": {}
-}
+    "zod": "^3.23.8"
+  }
+}

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

@@ -1,9 +1,10 @@
 import { TRPCError } from '@trpc/server';
+import { z } from 'zod';
 
 import { getTeamPrices } from '@documenso/ee/server-only/stripe/get-team-prices';
 import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
 import { acceptTeamInvitation } from '@documenso/lib/server-only/team/accept-team-invitation';
-import { createTeam } from '@documenso/lib/server-only/team/create-team';
+import { ZCreateTeamResponseSchema, createTeam } from '@documenso/lib/server-only/team/create-team';
 import { createTeamBillingPortal } from '@documenso/lib/server-only/team/create-team-billing-portal';
 import { createTeamPendingCheckoutSession } from '@documenso/lib/server-only/team/create-team-checkout-session';
 import { createTeamEmailVerification } from '@documenso/lib/server-only/team/create-team-email-verification';
@@ -17,22 +18,43 @@ import { deleteTeamMembers } from '@documenso/lib/server-only/team/delete-team-m
 import { deleteTeamPending } from '@documenso/lib/server-only/team/delete-team-pending';
 import { deleteTeamTransferRequest } from '@documenso/lib/server-only/team/delete-team-transfer-request';
 import { findTeamInvoices } from '@documenso/lib/server-only/team/find-team-invoices';
-import { findTeamMemberInvites } from '@documenso/lib/server-only/team/find-team-member-invites';
-import { findTeamMembers } from '@documenso/lib/server-only/team/find-team-members';
+import {
+  ZFindTeamMemberInvitesResponseSchema,
+  findTeamMemberInvites,
+} from '@documenso/lib/server-only/team/find-team-member-invites';
+import {
+  ZFindTeamMembersResponseSchema,
+  findTeamMembers,
+} from '@documenso/lib/server-only/team/find-team-members';
 import { findTeams } from '@documenso/lib/server-only/team/find-teams';
-import { findTeamsPending } from '@documenso/lib/server-only/team/find-teams-pending';
-import { getTeamById } from '@documenso/lib/server-only/team/get-team';
+import {
+  ZFindTeamsPendingResponseSchema,
+  findTeamsPending,
+} from '@documenso/lib/server-only/team/find-teams-pending';
+import { ZGetTeamByIdResponseSchema, getTeamById } from '@documenso/lib/server-only/team/get-team';
 import { getTeamEmailByEmail } from '@documenso/lib/server-only/team/get-team-email-by-email';
-import { getTeamInvitations } from '@documenso/lib/server-only/team/get-team-invitations';
-import { getTeamMembers } from '@documenso/lib/server-only/team/get-team-members';
-import { getTeams } from '@documenso/lib/server-only/team/get-teams';
+import {
+  ZGetTeamInvitationsResponseSchema,
+  getTeamInvitations,
+} from '@documenso/lib/server-only/team/get-team-invitations';
+import {
+  ZGetTeamMembersResponseSchema,
+  getTeamMembers,
+} from '@documenso/lib/server-only/team/get-team-members';
+import { ZGetTeamsResponseSchema, getTeams } from '@documenso/lib/server-only/team/get-teams';
 import { leaveTeam } from '@documenso/lib/server-only/team/leave-team';
 import { requestTeamOwnershipTransfer } from '@documenso/lib/server-only/team/request-team-ownership-transfer';
 import { resendTeamEmailVerification } from '@documenso/lib/server-only/team/resend-team-email-verification';
 import { resendTeamMemberInvitation } from '@documenso/lib/server-only/team/resend-team-member-invitation';
 import { updateTeam } from '@documenso/lib/server-only/team/update-team';
-import { updateTeamBrandingSettings } from '@documenso/lib/server-only/team/update-team-branding-settings';
-import { updateTeamDocumentSettings } from '@documenso/lib/server-only/team/update-team-document-settings';
+import {
+  ZUpdateTeamBrandingSettingsResponseSchema,
+  updateTeamBrandingSettings,
+} from '@documenso/lib/server-only/team/update-team-branding-settings';
+import {
+  ZUpdateTeamDocumentSettingsResponseSchema,
+  updateTeamDocumentSettings,
+} from '@documenso/lib/server-only/team/update-team-document-settings';
 import { updateTeamEmail } from '@documenso/lib/server-only/team/update-team-email';
 import { updateTeamMember } from '@documenso/lib/server-only/team/update-team-member';
 import { updateTeamPublicProfile } from '@documenso/lib/server-only/team/update-team-public-profile';
@@ -73,6 +95,7 @@ import {
 } from './schema';
 
 export const teamRouter = router({
+  // Internal endpoint for now.
   acceptTeamInvitation: authenticatedProcedure
     .input(ZAcceptTeamInvitationMutationSchema)
     .mutation(async ({ input, ctx }) => {
@@ -82,6 +105,7 @@ export const teamRouter = router({
       });
     }),
 
+  // Internal endpoint for now.
   declineTeamInvitation: authenticatedProcedure
     .input(ZDeclineTeamInvitationMutationSchema)
     .mutation(async ({ input, ctx }) => {
@@ -91,6 +115,7 @@ export const teamRouter = router({
       });
     }),
 
+  // Internal endpoint for now.
   createBillingPortal: authenticatedProcedure
     .input(ZCreateTeamBillingPortalMutationSchema)
     .mutation(async ({ input, ctx }) => {
@@ -101,7 +126,9 @@ export const teamRouter = router({
     }),
 
   createTeam: authenticatedProcedure
+    .meta({ openapi: { method: 'POST', path: '/team' } })
     .input(ZCreateTeamMutationSchema)
+    .output(ZCreateTeamResponseSchema)
     .mutation(async ({ input, ctx }) => {
       return await createTeam({
         userId: ctx.user.id,
@@ -110,7 +137,9 @@ export const teamRouter = router({
     }),
 
   createTeamEmailVerification: authenticatedProcedure
+    .meta({ openapi: { method: 'POST', path: '/team/{teamId}/email' } })
     .input(ZCreateTeamEmailVerificationMutationSchema)
+    .output(z.void())
     .mutation(async ({ input, ctx }) => {
       return await createTeamEmailVerification({
         teamId: input.teamId,
@@ -123,7 +152,9 @@ export const teamRouter = router({
     }),
 
   createTeamMemberInvites: authenticatedProcedure
+    .meta({ openapi: { method: 'POST', path: '/team/{teamId}/member/invite' } })
     .input(ZCreateTeamMemberInvitesMutationSchema)
+    .output(z.void())
     .mutation(async ({ input, ctx }) => {
       return await createTeamMemberInvites({
         userId: ctx.user.id,
@@ -132,6 +163,7 @@ export const teamRouter = router({
       });
     }),
 
+  // Internal endpoint for now.
   createTeamPendingCheckout: authenticatedProcedure
     .input(ZCreateTeamPendingCheckoutMutationSchema)
     .mutation(async ({ input, ctx }) => {
@@ -142,6 +174,7 @@ export const teamRouter = router({
     }),
 
   deleteTeam: authenticatedProcedure
+    // .meta({ openapi: { method: 'DELETE', path: '/team/{teamId}' } })
     .input(ZDeleteTeamMutationSchema)
     .mutation(async ({ input, ctx }) => {
       return await deleteTeam({
@@ -151,6 +184,7 @@ export const teamRouter = router({
     }),
 
   deleteTeamEmail: authenticatedProcedure
+    // .meta({ openapi: { method: 'DELETE', path: '/team/{teamId}/email' } })
     .input(ZDeleteTeamEmailMutationSchema)
     .mutation(async ({ input, ctx }) => {
       return await deleteTeamEmail({
@@ -161,6 +195,7 @@ export const teamRouter = router({
     }),
 
   deleteTeamEmailVerification: authenticatedProcedure
+    // .meta({ openapi: { method: 'DELETE', path: '/team/{teamId}/email-verification' } })
     .input(ZDeleteTeamEmailVerificationMutationSchema)
     .mutation(async ({ input, ctx }) => {
       return await deleteTeamEmailVerification({
@@ -170,6 +205,7 @@ export const teamRouter = router({
     }),
 
   deleteTeamMemberInvitations: authenticatedProcedure
+    // .meta({ openapi: { method: 'DELETE', path: '/team/{teamId}/member/invite' } })
     .input(ZDeleteTeamMemberInvitationsMutationSchema)
     .mutation(async ({ input, ctx }) => {
       return await deleteTeamMemberInvitations({
@@ -179,6 +215,7 @@ export const teamRouter = router({
     }),
 
   deleteTeamMembers: authenticatedProcedure
+    // .meta({ openapi: { method: 'DELETE', path: '/team/{teamId}/member' } })
     .input(ZDeleteTeamMembersMutationSchema)
     .mutation(async ({ input, ctx }) => {
       return await deleteTeamMembers({
@@ -188,6 +225,7 @@ export const teamRouter = router({
     }),
 
   deleteTeamPending: authenticatedProcedure
+    // .meta({ openapi: { method: 'DELETE', path: '/team-pending/{pendingTeamId}' } })
     .input(ZDeleteTeamPendingMutationSchema)
     .mutation(async ({ input, ctx }) => {
       return await deleteTeamPending({
@@ -197,6 +235,7 @@ export const teamRouter = router({
     }),
 
   deleteTeamTransferRequest: authenticatedProcedure
+    // .meta({ openapi: { method: 'DELETE', path: '/team/{teamId}/transfer' } })
     .input(ZDeleteTeamTransferRequestMutationSchema)
     .mutation(async ({ input, ctx }) => {
       return await deleteTeamTransferRequest({
@@ -205,6 +244,7 @@ export const teamRouter = router({
       });
     }),
 
+  // Internal endpoint for now.
   findTeamInvoices: authenticatedProcedure
     .input(ZFindTeamInvoicesQuerySchema)
     .query(async ({ input, ctx }) => {
@@ -215,7 +255,9 @@ export const teamRouter = router({
     }),
 
   findTeamMemberInvites: authenticatedProcedure
+    .meta({ openapi: { method: 'GET', path: '/team/{teamId}/member/invite' } })
     .input(ZFindTeamMemberInvitesQuerySchema)
+    .output(ZFindTeamMemberInvitesResponseSchema)
     .query(async ({ input, ctx }) => {
       return await findTeamMemberInvites({
         userId: ctx.user.id,
@@ -224,7 +266,9 @@ export const teamRouter = router({
     }),
 
   findTeamMembers: authenticatedProcedure
+    .meta({ openapi: { method: 'GET', path: '/team/{teamId}/member' } })
     .input(ZFindTeamMembersQuerySchema)
+    .output(ZFindTeamMembersResponseSchema)
     .query(async ({ input, ctx }) => {
       return await findTeamMembers({
         userId: ctx.user.id,
@@ -232,6 +276,7 @@ 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,
@@ -240,7 +285,9 @@ export const teamRouter = router({
   }),
 
   findTeamsPending: authenticatedProcedure
+    .meta({ openapi: { method: 'GET', path: '/team-pending' } })
     .input(ZFindTeamsPendingQuerySchema)
+    .output(ZFindTeamsPendingResponseSchema)
     .query(async ({ input, ctx }) => {
       return await findTeamsPending({
         userId: ctx.user.id,
@@ -248,34 +295,52 @@ export const teamRouter = router({
       });
     }),
 
-  getTeam: authenticatedProcedure.input(ZGetTeamQuerySchema).query(async ({ input, ctx }) => {
-    return await getTeamById({ teamId: input.teamId, userId: ctx.user.id });
-  }),
+  getTeam: authenticatedProcedure
+    .meta({ openapi: { method: 'GET', path: '/team/{teamId}' } })
+    .input(ZGetTeamQuerySchema)
+    .output(ZGetTeamByIdResponseSchema)
+    .query(async ({ input, ctx }) => {
+      return await getTeamById({ teamId: input.teamId, userId: ctx.user.id });
+    }),
 
+  // Todo
   getTeamEmailByEmail: authenticatedProcedure.query(async ({ ctx }) => {
     return await getTeamEmailByEmail({ email: ctx.user.email });
   }),
 
-  getTeamInvitations: authenticatedProcedure.query(async ({ ctx }) => {
-    return await getTeamInvitations({ email: ctx.user.email });
-  }),
+  getTeamInvitations: authenticatedProcedure
+    .meta({ openapi: { method: 'GET', path: '/team/invite' } })
+    .input(z.void())
+    .output(ZGetTeamInvitationsResponseSchema)
+    .query(async ({ ctx }) => {
+      return await getTeamInvitations({ email: ctx.user.email });
+    }),
 
   getTeamMembers: authenticatedProcedure
+    .meta({ openapi: { method: 'GET', path: '/team/member' } })
     .input(ZGetTeamMembersQuerySchema)
+    .output(ZGetTeamMembersResponseSchema)
     .query(async ({ input, ctx }) => {
       return await getTeamMembers({ teamId: input.teamId, userId: ctx.user.id });
     }),
 
+  // Internal endpoint for now.
   getTeamPrices: authenticatedProcedure.query(async () => {
     return await getTeamPrices();
   }),
 
-  getTeams: authenticatedProcedure.query(async ({ ctx }) => {
-    return await getTeams({ userId: ctx.user.id });
-  }),
+  getTeams: authenticatedProcedure
+    .meta({ openapi: { method: 'GET', path: '/team' } })
+    .input(z.void())
+    .output(ZGetTeamsResponseSchema)
+    .query(async ({ ctx }) => {
+      return await getTeams({ userId: ctx.user.id });
+    }),
 
   leaveTeam: authenticatedProcedure
+    .meta({ openapi: { method: 'POST', path: '/team/{teamId}/leave' } })
     .input(ZLeaveTeamMutationSchema)
+    .output(z.void())
     .mutation(async ({ input, ctx }) => {
       return await leaveTeam({
         userId: ctx.user.id,
@@ -284,7 +349,9 @@ export const teamRouter = router({
     }),
 
   updateTeam: authenticatedProcedure
+    .meta({ openapi: { method: 'PATCH', path: '/team/{teamId}' } })
     .input(ZUpdateTeamMutationSchema)
+    .output(z.void())
     .mutation(async ({ input, ctx }) => {
       return await updateTeam({
         userId: ctx.user.id,
@@ -293,7 +360,9 @@ export const teamRouter = router({
     }),
 
   updateTeamEmail: authenticatedProcedure
+    .meta({ openapi: { method: 'PATCH', path: '/team/{teamId}/email' } })
     .input(ZUpdateTeamEmailMutationSchema)
+    .output(z.void())
     .mutation(async ({ input, ctx }) => {
       return await updateTeamEmail({
         userId: ctx.user.id,
@@ -302,7 +371,9 @@ export const teamRouter = router({
     }),
 
   updateTeamMember: authenticatedProcedure
+    .meta({ openapi: { method: 'PATCH', path: '/team/{teamId}/member' } })
     .input(ZUpdateTeamMemberMutationSchema)
+    .output(z.void())
     .mutation(async ({ input, ctx }) => {
       return await updateTeamMember({
         userId: ctx.user.id,
@@ -311,12 +382,14 @@ export const teamRouter = router({
     }),
 
   updateTeamPublicProfile: authenticatedProcedure
+    .meta({ openapi: { method: 'PATCH', path: '/team/{teamId}/profile' } })
     .input(ZUpdateTeamPublicProfileMutationSchema)
+    .output(z.void())
     .mutation(async ({ input, ctx }) => {
       try {
         const { teamId, bio, enabled } = input;
 
-        const team = await updateTeamPublicProfile({
+        await updateTeamPublicProfile({
           userId: ctx.user.id,
           teamId,
           data: {
@@ -324,8 +397,6 @@ export const teamRouter = router({
             enabled,
           },
         });
-
-        return { success: true, url: team.url };
       } catch (err) {
         console.error(err);
 
@@ -344,7 +415,9 @@ export const teamRouter = router({
     }),
 
   requestTeamOwnershipTransfer: authenticatedProcedure
+    .meta({ openapi: { method: 'POST', path: '/team/{teamId}/transfer' } })
     .input(ZRequestTeamOwnerhsipTransferMutationSchema)
+    .output(z.void())
     .mutation(async ({ input, ctx }) => {
       return await requestTeamOwnershipTransfer({
         userId: ctx.user.id,
@@ -354,7 +427,9 @@ export const teamRouter = router({
     }),
 
   resendTeamEmailVerification: authenticatedProcedure
+    .meta({ openapi: { method: 'POST', path: '/team/{teamId}/email/resend' } })
     .input(ZResendTeamEmailVerificationMutationSchema)
+    .output(z.void())
     .mutation(async ({ input, ctx }) => {
       await resendTeamEmailVerification({
         userId: ctx.user.id,
@@ -363,7 +438,11 @@ export const teamRouter = router({
     }),
 
   resendTeamMemberInvitation: authenticatedProcedure
+    .meta({
+      openapi: { method: 'POST', path: '/team/{teamId}/member/invite/{invitationId}/resend' },
+    })
     .input(ZResendTeamMemberInvitationMutationSchema)
+    .output(z.void())
     .mutation(async ({ input, ctx }) => {
       await resendTeamMemberInvitation({
         userId: ctx.user.id,
@@ -373,7 +452,9 @@ export const teamRouter = router({
     }),
 
   updateTeamBrandingSettings: authenticatedProcedure
+    .meta({ openapi: { method: 'PATCH', path: '/team/{teamId}/branding' } })
     .input(ZUpdateTeamBrandingSettingsMutationSchema)
+    .output(ZUpdateTeamBrandingSettingsResponseSchema)
     .mutation(async ({ ctx, input }) => {
       const { teamId, settings } = input;
 
@@ -385,7 +466,9 @@ export const teamRouter = router({
     }),
 
   updateTeamDocumentSettings: authenticatedProcedure
+    .meta({ openapi: { method: 'PATCH', path: '/team/{teamId}/settings' } })
     .input(ZUpdateTeamDocumentSettingsMutationSchema)
+    .output(ZUpdateTeamDocumentSettingsResponseSchema)
     .mutation(async ({ ctx, input }) => {
       const { teamId, settings } = input;
 

packages/tsconfig/base.json

@@ -16,6 +16,7 @@
     "preserveWatchOutput": true,
     "skipLibCheck": true,
     "strict": true,
+    "strictNullChecks": true,
     "target": "ES2018"
   },
   "include": ["**/*.ts", "**/*.tsx", "**/.d.ts"],

packages/ui/package.json

@@ -78,6 +78,6 @@
     "tailwind-merge": "^1.12.0",
     "tailwindcss-animate": "^1.0.5",
     "ts-pattern": "^5.0.5",
-    "zod": "^3.22.4"
+    "zod": "^3.23.8"
   }
-}
+}