Skip to content

Papermark is the open-source DocSend alternative and secure data rooms with built-in analytics and custom domains.

feat: add custom fields to dataroom analytics and persist on links

Marc Seitzd5615a0bf7d0
diff --git a/components/datarooms/dataroom-header.tsx b/components/datarooms/dataroom-header.tsx
index 15593570..1be3693d 100644
--- a/components/datarooms/dataroom-header.tsx
+++ b/components/datarooms/dataroom-header.tsx
@@ -3,6 +3,8 @@ import { useState } from "react";
import LinkSheet from "@/components/links/link-sheet";
import { Button } from "@/components/ui/button";
+import { useDataroomLinks } from "@/lib/swr/use-dataroom";
+
export const DataroomHeader = ({
title,
description,
@@ -13,6 +15,7 @@ export const DataroomHeader = ({
actions?: React.ReactNode[];
}) => {
const [isLinkSheetOpen, setIsLinkSheetOpen] = useState<boolean>(false);
+ const { links } = useDataroomLinks();
const actionRows: React.ReactNode[][] = [];
if (actions) {
@@ -38,6 +41,7 @@ export const DataroomHeader = ({
linkType={"DATAROOM_LINK"}
isOpen={isLinkSheetOpen}
setIsOpen={setIsLinkSheetOpen}
+ existingLinks={links}
/>
</div>
</section>
diff --git a/components/visitors/dataroom-visitor-custom-fields.tsx b/components/visitors/dataroom-visitor-custom-fields.tsx
new file mode 100644
index 00000000..01c4d53e
--- /dev/null
+++ b/components/visitors/dataroom-visitor-custom-fields.tsx
@@ -0,0 +1,43 @@
+import { Fragment } from "react";
+
+import useSWR from "swr";
+
+import { fetcher } from "@/lib/utils";
+
+type CustomFieldResponse = {
+ identifier: string;
+ label: string;
+ response: string;
+};
+
+export default function VisitorCustomFields({
+ viewId,
+ teamId,
+ dataroomId,
+}: {
+ viewId: string;
+ teamId: string;
+ dataroomId: string;
+}) {
+ const { data: customFieldResponse } = useSWR<CustomFieldResponse[] | null>(
+ `/api/teams/${teamId}/datarooms/${dataroomId}/views/${viewId}/custom-fields`,
+ fetcher,
+ );
+
+ console.log("customFieldResponse", customFieldResponse);
+
+ if (!customFieldResponse) return null;
+
+ return (
+ <div className="space-y-2 px-1.5 pb-2 md:px-2">
+ <dl className="grid grid-cols-[auto_1fr] gap-x-4 gap-y-2">
+ {customFieldResponse.map((field, index) => (
+ <Fragment key={index}>
+ <dt className="text-sm text-muted-foreground">{field.label}</dt>
+ <dd className="text-sm">{field.response}</dd>
+ </Fragment>
+ ))}
+ </dl>
+ </div>
+ );
+}
diff --git a/components/visitors/dataroom-visitors-table.tsx b/components/visitors/dataroom-visitors-table.tsx
index b72ae926..aa9a77ac 100644
--- a/components/visitors/dataroom-visitors-table.tsx
+++ b/components/visitors/dataroom-visitors-table.tsx
@@ -27,8 +27,9 @@ import {
import { BadgeTooltip } from "@/components/ui/tooltip";
import { useDataroomVisits } from "@/lib/swr/use-dataroom";
-import { durationFormat, timeAgo } from "@/lib/utils";
+import { timeAgo } from "@/lib/utils";
+import DataroomVisitorCustomFields from "./dataroom-visitor-custom-fields";
import { DataroomVisitorUserAgent } from "./dataroom-visitor-useragent";
import DataroomVisitHistory from "./dataroom-visitors-history";
import { VisitorAvatar } from "./visitor-avatar";
@@ -201,6 +202,11 @@ export default function DataroomVisitorsTable({
<>
<TableRow>
<TableCell colSpan={3}>
+ <DataroomVisitorCustomFields
+ viewId={view.id}
+ teamId={view.teamId!}
+ dataroomId={dataroomId}
+ />
<DataroomVisitorUserAgent viewId={view.id} />
</TableCell>
</TableRow>
diff --git a/pages/api/teams/[teamId]/datarooms/[id]/links.ts b/pages/api/teams/[teamId]/datarooms/[id]/links.ts
index 23a0f5bd..8067f569 100644
--- a/pages/api/teams/[teamId]/datarooms/[id]/links.ts
+++ b/pages/api/teams/[teamId]/datarooms/[id]/links.ts
@@ -62,6 +62,7 @@ export default async function handle(
viewedAt: "desc",
},
},
+ customFields: true,
_count: {
select: { views: { where: { viewType: "DATAROOM_VIEW" } } },
},
diff --git a/pages/api/teams/[teamId]/datarooms/[id]/views/[viewId]/custom-fields.ts b/pages/api/teams/[teamId]/datarooms/[id]/views/[viewId]/custom-fields.ts
new file mode 100644
index 00000000..a2228353
--- /dev/null
+++ b/pages/api/teams/[teamId]/datarooms/[id]/views/[viewId]/custom-fields.ts
@@ -0,0 +1,80 @@
+import { NextApiRequest, NextApiResponse } from "next";
+
+import { authOptions } from "@/pages/api/auth/[...nextauth]";
+import { getServerSession } from "next-auth/next";
+
+import { errorhandler } from "@/lib/errorHandler";
+import prisma from "@/lib/prisma";
+import { CustomUser } from "@/lib/types";
+
+export default async function handle(
+ req: NextApiRequest,
+ res: NextApiResponse,
+) {
+ if (req.method === "GET") {
+ // GET /api/teams/:teamId/datarooms/:id/views/:viewId/custom-fields
+ const session = await getServerSession(req, res, authOptions);
+ if (!session) {
+ return res.status(401).end("Unauthorized");
+ }
+
+ const {
+ teamId,
+ id: dataroomId,
+ viewId,
+ } = req.query as {
+ teamId: string;
+ id: string;
+ viewId: string;
+ };
+
+ const userId = (session.user as CustomUser).id;
+
+ try {
+ const team = await prisma.team.findUnique({
+ where: {
+ id: teamId,
+ users: {
+ some: {
+ userId: userId,
+ },
+ },
+ },
+ select: {
+ id: true,
+ plan: true,
+ },
+ });
+
+ if (!team) {
+ return res.status(401).end("Unauthorized");
+ }
+
+ if (team.plan.includes("free")) {
+ return res.status(403).end("Forbidden");
+ }
+
+ const customFields = await prisma.customFieldResponse.findFirst({
+ where: {
+ viewId: viewId,
+ view: {
+ dataroomId: dataroomId,
+ },
+ },
+ select: {
+ data: true,
+ },
+ });
+
+ const data = customFields?.data;
+
+ return res.status(200).json(data);
+ } catch (error) {
+ errorhandler(error, res);
+ }
+ } else {
+ // We only allow GET requests
+ res.setHeader("Allow", ["GET"]);
+ return res.status(405).end(`Method ${req.method} Not Allowed`);
+ }
+}
diff --git a/pages/api/teams/[teamId]/documents/[id]/views/[viewId]/custom-fields.ts b/pages/api/teams/[teamId]/documents/[id]/views/[viewId]/custom-fields.ts
index 8e1c1b7c..89c07af9 100644
--- a/pages/api/teams/[teamId]/documents/[id]/views/[viewId]/custom-fields.ts
+++ b/pages/api/teams/[teamId]/documents/[id]/views/[viewId]/custom-fields.ts
@@ -57,6 +57,9 @@ export default async function handle(
const customFields = await prisma.customFieldResponse.findFirst({
where: {
viewId: viewId,
+ view: {
+ documentId: docId,
+ },
},
select: {
data: true,