feat: migrate templates and documents to envelope model

packages/lib/server-only/envelope/get-envelope-by-id.ts

@@ -0,0 +1,168 @@
+import type { Prisma } from '@prisma/client';
+import type { EnvelopeType } from '@prisma/client';
+
+import { prisma } from '@documenso/prisma';
+
+import { TEAM_DOCUMENT_VISIBILITY_MAP } from '../../constants/teams';
+import { AppError, AppErrorCode } from '../../errors/app-error';
+import type { EnvelopeIdOptions } from '../../utils/envelope';
+import { unsafeBuildEnvelopeIdQuery } from '../../utils/envelope';
+import { getTeamById } from '../team/get-team';
+
+export type GetEnvelopeByIdOptions = {
+  id: EnvelopeIdOptions;
+
+  /**
+   * The validated team ID.
+   */
+  userId: number;
+
+  /**
+   * The unvalidated team ID.
+   */
+  teamId: number;
+
+  /**
+   * The type of envelope to get.
+   *
+   * Set to null to bypass check.
+   */
+  type: EnvelopeType | null;
+};
+
+export const getEnvelopeById = async ({ id, userId, teamId, type }: GetEnvelopeByIdOptions) => {
+  const { envelopeWhereInput } = await getEnvelopeWhereInput({
+    id,
+    userId,
+    teamId,
+    type,
+  });
+
+  const envelope = await prisma.envelope.findFirst({
+    where: envelopeWhereInput,
+    include: {
+      envelopeItems: {
+        include: {
+          documentData: true,
+        },
+      },
+      folder: true,
+      documentMeta: true,
+      user: {
+        select: {
+          id: true,
+          name: true,
+          email: true,
+        },
+      },
+      recipients: true,
+      fields: true,
+      team: {
+        select: {
+          id: true,
+          url: true,
+        },
+      },
+    },
+  });
+
+  if (!envelope) {
+    throw new AppError(AppErrorCode.NOT_FOUND, {
+      message: 'Envelope could not be found',
+    });
+  }
+
+  return envelope;
+};
+
+export type GetEnvelopeByIdResponse = Awaited<ReturnType<typeof getEnvelopeById>>;
+
+export type GetEnvelopeWhereInputOptions = {
+  id: EnvelopeIdOptions;
+
+  /**
+   * The user ID who has been authenticated.
+   */
+  userId: number;
+
+  /**
+   * The unknown teamId from the request.
+   */
+  teamId: number;
+
+  /**
+   * The type of envelope to get.
+   *
+   * Set to null to bypass check.
+   */
+  type: EnvelopeType | null;
+};
+
+/**
+ * Generate the where input for a given Prisma envelope query.
+ *
+ * This will return a query that allows a user to get a document if they have valid access to it.
+ *
+ * NOTE: Be extremely careful when modifying this function. Needs at minimum two reviewers to approve any changes.
+ */
+export const getEnvelopeWhereInput = async ({
+  id,
+  userId,
+  teamId,
+  type,
+}: GetEnvelopeWhereInputOptions) => {
+  // Validate that the user belongs to the team provided.
+  const team = await getTeamById({ teamId, userId });
+
+  const envelopeOrInput: Prisma.EnvelopeWhereInput[] = [
+    // Allow access if they own the document.
+    {
+      userId,
+    },
+    // Or, if they belong to the team that the document is associated with.
+    {
+      visibility: {
+        in: TEAM_DOCUMENT_VISIBILITY_MAP[team.currentTeamRole],
+      },
+      teamId: team.id,
+    },
+  ];
+
+  // Allow access to documents sent from the team email.
+  if (team.teamEmail) {
+    envelopeOrInput.push({
+      user: {
+        email: team.teamEmail.email,
+      },
+    });
+  }
+
+  // @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+  // NOTE: DO NOT PUT ANY CODE AFTER THIS POINT.
+  // @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+
+  const envelopeWhereInput: Prisma.EnvelopeWhereUniqueInput = {
+    ...unsafeBuildEnvelopeIdQuery(id, type),
+    OR: envelopeOrInput,
+  };
+
+  // Final backup validation incase something goes wrong.
+  if (
+    !envelopeWhereInput.OR ||
+    envelopeWhereInput.OR.length < 2 ||
+    !userId ||
+    !teamId ||
+    !team.id ||
+    teamId !== team.id
+  ) {
+    throw new AppError(AppErrorCode.UNAUTHORIZED, {
+      message: 'Query not valid',
+    });
+  }
+
+  // Do not modify this return directly, all adjustments need to be made prior to the above if statement.
+  return {
+    envelopeWhereInput,
+    team,
+  };
+};