Skip to content

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

feat: add index file generation to viewer

Marc Seitz7defcc264c24
diff --git a/components/view/dataroom/index-file-dialog.tsx b/components/view/dataroom/index-file-dialog.tsx
index a0d50ae6..854ee421 100644
--- a/components/view/dataroom/index-file-dialog.tsx
+++ b/components/view/dataroom/index-file-dialog.tsx
@@ -21,18 +21,14 @@ import {
DialogTitle,
DialogTrigger,
} from "@/components/ui/dialog";
-import { Separator } from "@/components/ui/separator";
-import { ButtonTooltip } from "@/components/ui/tooltip";
interface IndexFileDialogProps {
linkId: string;
viewId: string;
disabled?: boolean;
dataroomId: string;
- isEmbedded?: boolean;
viewerEmail?: string;
viewerId?: string;
- verifiedEmail?: string;
}
export default function IndexFileDialog({
@@ -40,10 +36,8 @@ export default function IndexFileDialog({
viewId,
disabled = false,
dataroomId,
- isEmbedded,
viewerEmail,
viewerId,
- verifiedEmail,
}: IndexFileDialogProps) {
const [isLoading, setIsLoading] = useState(false);
const [selectedFormat, setSelectedFormat] =
@@ -69,6 +63,8 @@ export default function IndexFileDialog({
linkId,
format: selectedFormat,
dataroomId,
+ viewId,
+ viewerId,
}),
});
@@ -77,13 +73,12 @@ export default function IndexFileDialog({
throw new Error(errorData.error || "Failed to generate index");
}
analytics.identify(viewerEmail);
- analytics.capture("Index File Downloaded By Viewer", {
+ analytics.capture("Generated Index File by visitor", {
linkId: linkId,
dataroomId: dataroomId,
linkType: "dataroom",
viewerId: viewerId,
viewerEmail: viewerEmail,
- isEmbedded,
format: selectedFormat,
viewId: viewId,
});
@@ -123,19 +118,12 @@ export default function IndexFileDialog({
return (
<Dialog open={isOpen} onOpenChange={setIsOpen}>
- <ButtonTooltip content="Generate Index File">
- <DialogTrigger asChild>
- <Button
- className="m-1 bg-gray-900 text-white hover:bg-gray-900/80"
- size="icon"
- loading={isLoading}
- disabled={disabled}
- type="button"
- >
- <FileSlidersIcon className="h-5 w-5" />
- </Button>
- </DialogTrigger>
- </ButtonTooltip>
+ <DialogTrigger asChild>
+ <Button variant="outline" size="sm" disabled={disabled}>
+ <FileSlidersIcon />
+ Generate Index File
+ </Button>
+ </DialogTrigger>
<DialogContent className="sm:max-w-md">
<DialogHeader>
<DialogTitle>Generate Dataroom Index File</DialogTitle>
diff --git a/components/view/dataroom/nav-dataroom.tsx b/components/view/dataroom/nav-dataroom.tsx
index 4694f7d4..d866d77b 100644
--- a/components/view/dataroom/nav-dataroom.tsx
+++ b/components/view/dataroom/nav-dataroom.tsx
@@ -18,7 +18,6 @@ import { TooltipProvider } from "@/components/ui/tooltip";
import { Button } from "../../ui/button";
import { ConversationSidebar } from "../conversations/sidebar";
-import IndexFileDialog from "./index-file-dialog";
export default function DataroomNav({
allowDownload,
@@ -30,9 +29,6 @@ export default function DataroomNav({
dataroomId,
viewerId,
conversationsEnabled,
- enableIndexFile,
- isEmbedded,
- viewerEmail,
isTeamMember,
}: {
allowDownload?: boolean;
@@ -44,9 +40,6 @@ export default function DataroomNav({
dataroomId?: string;
viewerId?: string;
conversationsEnabled?: boolean;
- enableIndexFile?: boolean;
- isEmbedded?: boolean;
- viewerEmail?: string;
isTeamMember?: boolean;
}) {
const [loading, setLoading] = useState<boolean>(false);
@@ -195,17 +188,6 @@ export default function DataroomNav({
</Tooltip>
</TooltipProvider>
)}
- {enableIndexFile && (
- <IndexFileDialog
- linkId={linkId!}
- viewId={viewId!}
- disabled={isPreview}
- dataroomId={dataroomId!}
- isEmbedded={isEmbedded}
- viewerEmail={viewerEmail}
- viewerId={viewerId}
- />
- )}
{allowDownload ? (
<ButtonTooltip content="Download Dataroom">
<Button
diff --git a/components/view/viewer/dataroom-viewer.tsx b/components/view/viewer/dataroom-viewer.tsx
index a0b20952..9aa85fbd 100644
--- a/components/view/viewer/dataroom-viewer.tsx
+++ b/components/view/viewer/dataroom-viewer.tsx
@@ -32,6 +32,7 @@ import { DEFAULT_DATAROOM_VIEW_TYPE } from "../dataroom/dataroom-view";
import DocumentCard from "../dataroom/document-card";
import { DocumentUploadModal } from "../dataroom/document-upload-modal";
import FolderCard from "../dataroom/folder-card";
+import IndexFileDialog from "../dataroom/index-file-dialog";
import DataroomNav from "../dataroom/nav-dataroom";
type FolderOrDocument =
@@ -221,9 +222,6 @@ export default function DataroomViewer({
dataroomId={dataroom?.id}
viewerId={viewerId}
conversationsEnabled={viewData.conversationsEnabled}
- enableIndexFile={enableIndexFile}
- isEmbedded={isEmbedded}
- viewerEmail={viewerEmail}
isTeamMember={viewData.isTeamMember}
/>
<div
@@ -317,14 +315,26 @@ export default function DataroomViewer({
</BreadcrumbList>
</Breadcrumb>
- {viewData?.enableVisitorUpload && viewerId && (
- <DocumentUploadModal
- linkId={linkId}
- dataroomId={dataroom?.id}
- viewerId={viewerId}
- folderId={folderId ?? undefined}
- />
- )}
+ <div className="flex items-center gap-x-2">
+ {enableIndexFile && viewId && viewerId && (
+ <IndexFileDialog
+ linkId={linkId}
+ viewId={viewId}
+ dataroomId={dataroom?.id}
+ viewerId={viewerId}
+ viewerEmail={viewerEmail}
+ />
+ )}
+
+ {viewData?.enableVisitorUpload && viewerId && (
+ <DocumentUploadModal
+ linkId={linkId}
+ dataroomId={dataroom?.id}
+ viewerId={viewerId}
+ folderId={folderId ?? undefined}
+ />
+ )}
+ </div>
</div>
</div>
<ul role="list" className="-mx-4 space-y-4 overflow-auto p-4">
diff --git a/pages/api/links/domains/[...domainSlug].ts b/pages/api/links/domains/[...domainSlug].ts
index 902c860a..55953a3e 100644
--- a/pages/api/links/domains/[...domainSlug].ts
+++ b/pages/api/links/domains/[...domainSlug].ts
@@ -51,6 +51,7 @@ export default async function handle(
enableCustomMetatag: true,
enableFeedback: true,
enableScreenshotProtection: true,
+ enableIndexFile: true,
metaTitle: true,
metaDescription: true,
metaImage: true,
diff --git a/pages/api/links/generate-index.ts b/pages/api/links/generate-index.ts
new file mode 100644
index 00000000..58f65340
--- /dev/null
+++ b/pages/api/links/generate-index.ts
@@ -0,0 +1,200 @@
+import { NextApiRequest, NextApiResponse } from "next";
+
+import { authOptions } from "@/pages/api/auth/[...nextauth]";
+import { ItemType } from "@prisma/client";
+import { getServerSession } from "next-auth/next";
+
+import { generateDataroomIndex } from "@/lib/dataroom/index-generator";
+import prisma from "@/lib/prisma";
+import { CustomUser, LinkWithDataroom } from "@/lib/types";
+import { IndexFileFormat } from "@/lib/types/index-file";
+
+export default async function handle(
+ req: NextApiRequest,
+ res: NextApiResponse,
+) {
+ // POST /api/links/generate-index
+ if (req.method !== "POST") {
+ return res.status(405).json({ error: "Method not allowed" });
+ }
+
+ const {
+ format = "excel",
+ linkId,
+ viewId,
+ dataroomId,
+ viewerId,
+ } = req.body as {
+ format: IndexFileFormat;
+ linkId: string;
+ viewId: string;
+ dataroomId: string;
+ viewerId: string;
+ };
+
+ try {
+ const view = await prisma.view.findUnique({
+ where: {
+ id: viewId,
+ linkId: linkId,
+ },
+ select: {
+ id: true,
+ linkId: true,
+ dataroomId: true,
+ viewerId: true,
+ link: {
+ select: {
+ id: true,
+ dataroomId: true,
+ linkType: true,
+ url: true,
+ name: true,
+ slug: true,
+ expiresAt: true,
+ createdAt: true,
+ updatedAt: true,
+ teamId: true,
+ isArchived: true,
+ domainId: true,
+ domainSlug: true,
+ groupId: true,
+ enableIndexFile: true,
+ dataroom: {
+ select: {
+ id: true,
+ name: true,
+ teamId: true,
+ documents: {
+ include: {
+ document: {
+ include: {
+ versions: { where: { isPrimary: true } },
+ },
+ },
+ },
+ },
+ folders: true,
+ updatedAt: true,
+ createdAt: true,
+ },
+ },
+ },
+ },
+ },
+ });
+
+ if (
+ !view ||
+ !view.link ||
+ view.dataroomId !== dataroomId ||
+ view.viewerId !== viewerId
+ ) {
+ return res.status(404).json({ error: "View not found" });
+ }
+
+ const link = view.link;
+
+ if (!link || !link.dataroom || link.dataroom.id !== dataroomId) {
+ return res.status(404).json({ error: "Link not found" });
+ }
+
+ if (!link.enableIndexFile) {
+ return res
+ .status(404)
+ .json({ error: "Index file is not enabled for this link" });
+ }
+
+ // check if link is expired or archived
+ if (link.expiresAt && link.expiresAt < new Date()) {
+ return res.status(404).json({ error: "Link expired" });
+ }
+
+ if (link.isArchived) {
+ return res.status(404).json({ error: "Link archived" });
+ }
+
+ // Check if the link is a group link and remove the folder/documents from the dataroom if not part of the group permissions
+ if (link.groupId) {
+ const groupAccessControls =
+ await prisma.viewerGroupAccessControls.findMany({
+ where: {
+ groupId: link.groupId,
+ OR: [{ canView: true }, { canDownload: true }],
+ },
+ select: {
+ itemId: true,
+ itemType: true,
+ },
+ });
+
+ const allowedDocuments = groupAccessControls
+ .filter((control) => control.itemType === ItemType.DATAROOM_DOCUMENT)
+ .map((control) => control.itemId);
+ const allowedFolders = groupAccessControls
+ .filter((control) => control.itemType === ItemType.DATAROOM_FOLDER)
+ .map((control) => control.itemId);
+
+ link.dataroom.documents = link.dataroom.documents.filter((doc) =>
+ allowedDocuments.includes(doc.id),
+ );
+ link.dataroom.folders = link.dataroom.folders.filter((folder) =>
+ allowedFolders.includes(folder.id),
+ );
+ }
+
+ // Map updatedAt to lastUpdatedAt for the dataroom and transform document versions
+ // @ts-ignore
+ const linkWithDataroom: LinkWithDataroom = {
+ ...link,
+ dataroom: {
+ ...link.dataroom,
+ createdAt: link.dataroom.createdAt,
+ lastUpdatedAt: link.dataroom.updatedAt,
+ documents: link.dataroom.documents.map((doc) => ({
+ id: doc.id,
+ folderId: doc.folderId,
+ orderIndex: doc.orderIndex,
+ updatedAt: doc.updatedAt,
+ createdAt: doc.createdAt,
+ document: {
+ id: doc.document.id,
+ name: doc.document.name,
+ versions: doc.document.versions.map((version) => ({
+ id: version.id,
+ versionNumber: version.versionNumber,
+ type: version.contentType || "unknown",
+ hasPages: version.hasPages,
+ file: version.file,
+ isVertical: version.isVertical,
+ numPages: version.numPages,
+ updatedAt: version.updatedAt,
+ fileSize: version.fileSize,
+ })),
+ },
+ })),
+ },
+ };
+
+ // Generate the index file using the appropriate generator
+ const { data, filename, mimeType } = await generateDataroomIndex(
+ linkWithDataroom,
+ {
+ format,
+ baseUrl: link.domainId
+ ? `${link.domainSlug}/${link.slug}`
+ : `${process.env.NEXT_PUBLIC_MARKETING_URL}/view/${link.id}`,
+ },
+ );
+
+ // Set response headers for file download
+ res.setHeader("Content-Type", mimeType);
+ res.setHeader("Content-Disposition", `attachment; filename=${filename}`);
+
+ // Send the file
+ return res.send(data);
+ } catch (error) {
+ console.error("Request error", error);
+ return res.status(500).json({ error: "Error generating index" });
+ }
+}