Skip to content

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

feat: add document pages

Marc Seitz9b67e0a875ab
diff --git a/components/PagesViewer.tsx b/components/PagesViewer.tsx
new file mode 100644
index 00000000..45bdc095
--- /dev/null
+++ b/components/PagesViewer.tsx
@@ -0,0 +1,150 @@
+import { ChevronLeftIcon, ChevronRightIcon } from "@heroicons/react/20/solid";
+import { useEffect, useRef, useState } from "react";
+import Image from "next/image";
+
+export default function PagesViewer({pages, linkId, documentId, viewId}: {pages: { file: string, pageNumber: string }[], linkId: string, documentId: string, viewId: string}) {
+ const [pageNumber, setPageNumber] = useState<number>(1); // start on first page
+
+ const startTimeRef = useRef(Date.now());
+ const pageNumberRef = useRef<number>(pageNumber);
+ const isInitialPageLoad = useRef(true);
+
+ const numPages = pages.length;
+
+ // Update the previous page number after the effect hook has run
+ useEffect(() => {
+ pageNumberRef.current = pageNumber;
+ }, [pageNumber]);
+
+ useEffect(() => {
+ startTimeRef.current = Date.now(); // update the start time for the new page
+
+ // when component unmounts, calculate duration and track page view
+ return () => {
+ const endTime = Date.now();
+ const duration = Math.round(endTime - startTimeRef.current);
+ trackPageView(duration);
+ };
+ }, [pageNumber]); // monitor pageNumber for changes
+
+ // Send the last page view when the user leaves the page
+ useEffect(() => {
+ const handleBeforeUnload = () => {
+ const endTime = Date.now();
+ const duration = Math.round(endTime - startTimeRef.current);
+ trackPageView(duration);
+ };
+
+ window.addEventListener("beforeunload", handleBeforeUnload);
+
+ return () => {
+ window.removeEventListener("beforeunload", handleBeforeUnload);
+ };
+ }, []);
+
+ // Go to next page
+ function goToNextPage() {
+ setPageNumber((prevPageNumber) => prevPageNumber + 1);
+ }
+
+ // Go to previous page
+ function goToPreviousPage() {
+ setPageNumber((prevPageNumber) => prevPageNumber - 1);
+ }
+
+ async function trackPageView(duration: number = 0) {
+ // If this is the initial page load, don't send the request
+ if (isInitialPageLoad.current) {
+ isInitialPageLoad.current = false;
+ return;
+ }
+
+ await fetch("/api/record_view", {
+ method: "POST",
+ body: JSON.stringify({
+ linkId: linkId,
+ documentId: documentId,
+ viewId: viewId,
+ duration: duration,
+ pageNumber: pageNumberRef.current,
+ }),
+ headers: {
+ "Content-Type": "application/json",
+ },
+ });
+ }
+
+ return (
+ <>
+ <Nav pageNumber={pageNumber} numPages={numPages} />
+ <div
+ style={{ height: "calc(100vh - 64px)" }}
+ className="flex items-center relative"
+ >
+ <div className="flex items-center justify-between w-full absolute z-10 px-2">
+ <button
+ onClick={goToPreviousPage}
+ disabled={pageNumber == 1}
+ className="relative h-[calc(100vh - 64px)] px-2 py-24 focus:z-20 "
+ >
+ <span className="sr-only">Previous</span>
+ <div className="bg-gray-950/50 hover:bg-gray-950/75 rounded-full relative flex items-center justify-center p-1">
+ <ChevronLeftIcon
+ className="h-10 w-10 text-white"
+ aria-hidden="true"
+ />
+ </div>
+ </button>
+ <button
+ onClick={goToNextPage}
+ disabled={pageNumber >= numPages}
+ className="relative h-[calc(100vh - 64px)] px-2 py-24 focus:z-20"
+ >
+ <span className="sr-only">Next</span>
+ <div className="bg-gray-950/50 hover:bg-gray-950/75 rounded-full relative flex items-center justify-center p-1">
+ <ChevronRightIcon
+ className="h-10 w-10 text-white"
+ aria-hidden="true"
+ />
+ </div>
+ </button>
+ </div>
+
+ <div className="flex justify-center mx-auto">
+ <Image
+ className="object-contain mx-auto"
+ src={pages[pageNumber - 1].file}
+ alt={`Page ${pageNumber}`}
+ fill
+ priority={pageNumber == 1}
+ />
+ </div>
+ </div>
+ </>
+ );
+}
+
+
+function Nav({pageNumber, numPages}: {pageNumber: number, numPages: number}) {
+ return (
+ <nav className="bg-black">
+ <div className="mx-auto px-2 sm:px-6 lg:px-8">
+ <div className="relative flex h-16 items-center justify-between">
+ <div className="flex flex-1 items-center justify-center sm:items-stretch sm:justify-start">
+ <div className="flex flex-shrink-0 items-center">
+ <p className="text-2xl font-bold tracking-tighter text-white">
+ Papermark
+ </p>
+ </div>
+ </div>
+ <div className="absolute inset-y-0 right-0 flex items-center pr-2 sm:static sm:inset-auto sm:ml-6 sm:pr-0">
+ <div className="bg-gray-900 text-white rounded-md px-3 py-2 text-sm font-medium">
+ <span>{pageNumber}</span>
+ <span className="text-gray-400"> / {numPages}</span>
+ </div>
+ </div>
+ </div>
+ </div>
+ </nav>
+ );
+}
\ No newline at end of file
diff --git a/components/view/document-view.tsx b/components/view/document-view.tsx
index b9b9d455..d10e7f53 100644
--- a/components/view/document-view.tsx
+++ b/components/view/document-view.tsx
@@ -1,5 +1,4 @@
import React, { useEffect, useRef, useState } from "react";
-import { getExtension } from "@/lib/utils";
import ErrorPage from "next/error";
import PDFViewer from "@/components/PDFViewer";
import AccessForm from "@/components/view/access-form";
@@ -8,6 +7,7 @@ import { usePlausible } from "next-plausible";
import { toast } from "sonner";
import { LinkWithDocument } from "@/lib/types";
import LoadingSpinner from "../ui/loading-spinner";
+import PagesViewer from "@/components/PagesViewer";
export const DEFAULT_ACCESS_FORM_DATA = {
email: null,
@@ -21,7 +21,8 @@ export type DEFAULT_ACCESS_FORM_TYPE = {
export type DEFAULT_DOCUMENT_VIEW_TYPE = {
viewId: string;
- file: string;
+ file: string | null;
+ pages: {file: string, pageNumber: string}[] | null;
};
export default function DocumentView({
@@ -39,7 +40,8 @@ export default function DocumentView({
const hasInitiatedSubmit = useRef(false);
const [viewData, setViewData] = useState<DEFAULT_DOCUMENT_VIEW_TYPE>({
viewId: "",
- file: "",
+ file: null,
+ pages: null,
});
const [data, setData] = useState<DEFAULT_ACCESS_FORM_TYPE>(
@@ -86,12 +88,10 @@ export default function DocumentView({
});
if (response.ok) {
- const { viewId, file } = (await response.json()) as {
- viewId: string;
- file: string;
- };
+ const { viewId, file, pages } =
+ (await response.json()) as DEFAULT_DOCUMENT_VIEW_TYPE;
plausible("documentViewed"); // track the event
- setViewData({ viewId, file });
+ setViewData({ viewId, file, pages });
setSubmitted(true);
} else {
const { message } = await response.json();
@@ -128,47 +128,23 @@ export default function DocumentView({
handleSubmission();
}
- // get the file extension
- const extension = getExtension(viewData.file);
-
- if (
- extension.includes(".docx") ||
- extension.includes(".pptx") ||
- extension.includes(".xlsx") ||
- extension.includes(".xls") ||
- extension.includes(".doc") ||
- extension.includes(".ppt")
- ) {
- return (
- <div className="h-screen bg-gray-900">
- <iframe
- className="w-full h-full"
- src={`https://view.officeapps.live.com/op/embed.aspx?src=${viewData.file}`}
- ></iframe>
- </div>
- );
- }
-
- if (
- extension.includes(".png") ||
- extension.includes(".jpeg") ||
- extension.includes(".gif") ||
- extension.includes(".jpg")
- ) {
- return (
- <div className="h-screen bg-gray-900">
- <img className="w-full h-full" src={viewData.file} />
- </div>
- );
- }
return (
<div className="bg-gray-950">
- <PDFViewer
- file={viewData.file}
- viewId={viewData.viewId}
- linkId={link.id}
- documentId={document.id}
- />
+ {viewData.pages ? (
+ <PagesViewer
+ pages={viewData.pages}
+ viewId={viewData.viewId}
+ linkId={link.id}
+ documentId={document.id}
+ />
+ ) : (
+ <PDFViewer
+ file={viewData.file}
+ viewId={viewData.viewId}
+ linkId={link.id}
+ documentId={document.id}
+ />
+ )}
</div>
);
}
diff --git a/pages/api/views.ts b/pages/api/views.ts
index eac6e719..ccde0311 100644
--- a/pages/api/views.ts
+++ b/pages/api/views.ts
@@ -72,7 +72,7 @@ export default async function handle(
where: { isPrimary: true },
orderBy: { createdAt: "desc" },
take: 1,
- select: { file: true },
+ select: { file: true, id: true, hasPages: true },
},
},
},
@@ -90,9 +90,36 @@ export default async function handle(
viewerEmail: email,
});
- res.status(200).json({ message: "View recorded", viewId: newView.id, file: newView.document.versions[0].file });
+ // check if document version has multiple pages, if so, return the pages
+ if (newView.document.versions[0].hasPages) {
+ const pages = await prisma.documentPage.findMany({
+ where: {
+ versionId: newView.document.versions[0].id,
+ },
+ orderBy: {
+ pageNumber: "asc",
+ },
+ select: {
+ file: true,
+ pageNumber: true,
+ },
+ });
+
+ return res
+ .status(200)
+ .json({ message: "View recorded", viewId: newView.id, file: null, pages: pages });
+ }
+
+ return res
+ .status(200)
+ .json({
+ message: "View recorded",
+ viewId: newView.id,
+ file: newView.document.versions[0].file,
+ pages: null,
+ });
} catch (error) {
log(`Failed to record view for ${linkId}. Error: \n\n ${error}`);
- res.status(500).json({ message: (error as Error).message });
+ return res.status(500).json({ message: (error as Error).message });
}
}
diff --git a/prisma/migrations/20231014200337_create_document_pages/migration.sql b/prisma/migrations/20231014200337_create_document_pages/migration.sql
new file mode 100644
index 00000000..e37ec0bf
--- /dev/null
+++ b/prisma/migrations/20231014200337_create_document_pages/migration.sql
@@ -0,0 +1,29 @@
+/*
+ Warnings:
+
+ - A unique constraint covering the columns `[versionNumber,documentId]` on the table `DocumentVersion` will be added. If there are existing duplicate values, this will fail.
+
+*/
+-- AlterTable
+ALTER TABLE "DocumentVersion" ADD COLUMN "hasPages" BOOLEAN NOT NULL DEFAULT false;
+
+-- CreateTable
+CREATE TABLE "DocumentPage" (
+ "id" TEXT NOT NULL,
+ "versionId" TEXT NOT NULL,
+ "pageNumber" INTEGER NOT NULL,
+ "file" TEXT NOT NULL,
+ "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+ "updatedAt" TIMESTAMP(3) NOT NULL,
+
+ CONSTRAINT "DocumentPage_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "DocumentPage_pageNumber_versionId_key" ON "DocumentPage"("pageNumber", "versionId");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "DocumentVersion_versionNumber_documentId_key" ON "DocumentVersion"("versionNumber", "documentId");
+
+-- AddForeignKey
+ALTER TABLE "DocumentPage" ADD CONSTRAINT "DocumentPage_versionId_fkey" FOREIGN KEY ("versionId") REFERENCES "DocumentVersion"("id") ON DELETE CASCADE ON UPDATE CASCADE;
diff --git a/prisma/schema.prisma b/prisma/schema.prisma
index 43eabd27..38e071c6 100644
--- a/prisma/schema.prisma
+++ b/prisma/schema.prisma
@@ -88,12 +88,26 @@ model DocumentVersion {
type String? // This should be a reference to the file type (pdf, docx, etc.)
numPages Int? // This should be a reference to the number of pages in the document
isPrimary Boolean @default(false) // Indicates if this is the primary version
+ pages DocumentPage[]
+ hasPages Boolean @default(false) // Indicates if the document has pages
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
@@unique([versionNumber, documentId])
}
+model DocumentPage {
+ id String @id @default(cuid())
+ version DocumentVersion @relation(fields: [versionId], references: [id], onDelete: Cascade)
+ versionId String
+ pageNumber Int // e.g., 1, 2, 3 for
+ file String // This should be a reference to where the file / page is stored (S3, Google Cloud Storage, etc.)
+ createdAt DateTime @default(now())
+ updatedAt DateTime @updatedAt
+
+ @@unique([pageNumber, versionId])
+}
+
model Link {
id String @id @default(cuid())
document Document @relation(fields: [documentId], references: [id], onDelete: Cascade)