Papermark is the open-source DocSend alternative and secure data rooms with built-in analytics and custom domains.
feat: implement lazy page URL loading for document viewers
Cursor Agent611ecac25719
diff --git a/app/api/views-dataroom/route.ts b/app/api/views-dataroom/route.tsindex 913a28d4..1168cbb4 100644--- a/app/api/views-dataroom/route.ts+++ b/app/api/views-dataroom/route.ts@@ -871,6 +871,7 @@ export async function POST(request: NextRequest) {// otherwise, return file from document versionlet documentPages, documentVersion;let sheetData;+ const INITIAL_PAGES_TO_LOAD = 10;if (hasPages) {// get pages from document version@@ -888,12 +889,17 @@ export async function POST(request: NextRequest) {},});+ // Only sign URLs for the first batch of pages to avoid timeouts on large documents.+ // Remaining page URLs are fetched on-demand by the client via /api/views/pages.documentPages = await Promise.all(- documentPages.map(async (page) => {+ documentPages.map(async (page, index) => {const { storageType, ...otherPage } = page;return {...otherPage,- file: await getFile({ data: page.file, type: storageType }),+ file:+ index < INITIAL_PAGES_TO_LOAD+ ? await getFile({ data: page.file, type: storageType })+ : null,};}),);diff --git a/app/api/views/pages/route.ts b/app/api/views/pages/route.tsnew file mode 100644index 00000000..c390b5a8--- /dev/null+++ b/app/api/views/pages/route.ts@@ -0,0 +1,83 @@+import { NextRequest, NextResponse } from "next/server";++import { getFile } from "@/lib/files/get-file";+import prisma from "@/lib/prisma";+import { log } from "@/lib/utils";++const MAX_PAGES_PER_REQUEST = 50;++export async function POST(request: NextRequest) {+ try {+ const body = await request.json();++ const { viewId, documentVersionId, pageNumbers } = body as {+ viewId: string;+ documentVersionId: string;+ pageNumbers: number[];+ };++ if (!documentVersionId || !pageNumbers || pageNumbers.length === 0) {+ return NextResponse.json(+ { message: "Missing required fields." },+ { status: 400 },+ );+ }++ if (pageNumbers.length > MAX_PAGES_PER_REQUEST) {+ return NextResponse.json(+ {+ message: `Cannot request more than ${MAX_PAGES_PER_REQUEST} pages at once.`,+ },+ { status: 400 },+ );+ }++ // Validate viewId if provided (non-preview requests)+ if (viewId) {+ const view = await prisma.view.findUnique({+ where: { id: viewId },+ select: { id: true },+ });++ if (!view) {+ return NextResponse.json(+ { message: "View not found." },+ { status: 404 },+ );+ }+ }++ const documentPages = await prisma.documentPage.findMany({+ where: {+ versionId: documentVersionId,+ pageNumber: { in: pageNumbers },+ },+ select: {+ file: true,+ storageType: true,+ pageNumber: true,+ },+ });++ const pagesWithUrls = await Promise.all(+ documentPages.map(async (page) => {+ const { storageType, ...otherPage } = page;+ return {+ pageNumber: otherPage.pageNumber,+ file: await getFile({ data: page.file, type: storageType }),+ };+ }),+ );++ return NextResponse.json({ pages: pagesWithUrls });+ } catch (error) {+ log({+ message: `Failed to fetch page URLs. \n\n ${error}`,+ type: "error",+ });+ return NextResponse.json(+ { message: (error as Error).message },+ { status: 500 },+ );+ }+}diff --git a/app/api/views/route.ts b/app/api/views/route.tsindex 75427660..01d98706 100644--- a/app/api/views/route.ts+++ b/app/api/views/route.ts@@ -584,6 +584,7 @@ export async function POST(request: NextRequest) {// otherwise, return file from document versionlet documentPages, documentVersion;let sheetData;+ const INITIAL_PAGES_TO_LOAD = 10;// let documentPagesPromise, documentVersionPromise;if (hasPages) {const featureFlags = await getFeatureFlags({@@ -607,12 +608,17 @@ export async function POST(request: NextRequest) {},});+ // Only sign URLs for the first batch of pages to avoid timeouts on large documents.+ // Remaining page URLs are fetched on-demand by the client via /api/views/pages.documentPages = await Promise.all(- documentPages.map(async (page) => {+ documentPages.map(async (page, index) => {const { storageType, ...otherPage } = page;return {...otherPage,- file: await getFile({ data: page.file, type: storageType }),+ file:+ index < INITIAL_PAGES_TO_LOAD+ ? await getFile({ data: page.file, type: storageType })+ : null,};}),);diff --git a/components/documents/preview-viewers/preview-pages-viewer.tsx b/components/documents/preview-viewers/preview-pages-viewer.tsxindex c8eed104..507f78bc 100644--- a/components/documents/preview-viewers/preview-pages-viewer.tsx+++ b/components/documents/preview-viewers/preview-pages-viewer.tsx@@ -1,4 +1,4 @@-import { useCallback, useEffect, useState } from "react";+import { useCallback, useEffect, useRef, useState } from "react";import { ChevronLeftIcon, ChevronRightIcon } from "lucide-react";@@ -7,20 +7,86 @@ import { cn } from "@/lib/utils";import { Button } from "@/components/ui/button";+const PRELOAD_RADIUS = 5;+interface PreviewPagesViewerProps {documentData: DocumentPreviewData;onClose: () => void;+ pagesApiEndpoint?: string;}export function PreviewPagesViewer({documentData,onClose,+ pagesApiEndpoint,}: PreviewPagesViewerProps) {const [currentPage, setCurrentPage] = useState(1);const [imageCache, setImageCache] = useState<{ [key: number]: boolean }>({});const [imageLoaded, setImageLoaded] = useState(imageCache[1] || false);+ const [pages, setPages] = useState(documentData.pages ?? []);+ const pendingRef = useRef<Set<number>>(new Set());++ const { numPages, documentName, isVertical } = documentData;- const { pages, numPages, documentName, isVertical } = documentData;+ useEffect(() => {+ setPages(documentData.pages ?? []);+ }, [documentData.pages]);++ const ensurePagesLoaded = useCallback(+ async (centerPage: number) => {+ if (!pagesApiEndpoint) return;++ const start = Math.max(1, centerPage - PRELOAD_RADIUS);+ const end = Math.min(numPages, centerPage + PRELOAD_RADIUS);+ const needed: number[] = [];++ for (let i = start; i <= end; i++) {+ if (+ !pages[i - 1]?.file &&+ !pendingRef.current.has(i) &&+ i <= pages.length+ ) {+ needed.push(i);+ }+ }++ if (needed.length === 0) return;++ needed.forEach((pn) => pendingRef.current.add(pn));++ try {+ const response = await fetch(pagesApiEndpoint, {+ method: "POST",+ headers: { "Content-Type": "application/json" },+ body: JSON.stringify({ pageNumbers: needed }),+ });++ if (response.ok) {+ const data = await response.json();+ setPages((prev) => {+ const updated = [...prev];+ for (const fetchedPage of data.pages) {+ const idx = fetchedPage.pageNumber - 1;+ if (idx >= 0 && idx < updated.length && updated[idx]) {+ updated[idx] = {+ ...updated[idx],+ file: fetchedPage.file,+ };+ }+ }+ return updated;+ });+ }+ } finally {+ needed.forEach((pn) => pendingRef.current.delete(pn));+ }+ },+ [pagesApiEndpoint, pages, numPages],+ );++ useEffect(() => {+ ensurePagesLoaded(currentPage);+ }, [currentPage, ensurePagesLoaded]);const goToNextPage = useCallback(() => {if (currentPage < numPages) {@@ -78,6 +144,8 @@ export function PreviewPagesViewer({);}+ const hasFileUrl = !!currentPageData.file;+return (<div className="relative h-full w-full overflow-hidden">{/* Navigation Controls */}@@ -127,27 +195,29 @@ export function PreviewPagesViewer({{/* Page Content */}<div className="flex h-full w-full items-center justify-center p-4"><div className="relative max-h-full max-w-full">- {!imageLoaded && (+ {(!imageLoaded || !hasFileUrl) && (<div className="absolute inset-0 flex items-center justify-center"><div className="h-8 w-8 animate-spin rounded-full border-2 border-white border-t-transparent"></div></div>)}- <img- src={currentPageData.file}- alt={`Page ${currentPage}`}- className={cn(- "max-h-[calc(100vh-120px)] max-w-full object-contain transition-opacity duration-200",- imageLoaded ? "opacity-100" : "opacity-0",- )}- onLoad={handleImageLoad}- onError={() => {- setImageLoaded(true);- setImageCache((prev) => ({ ...prev, [currentPage]: true }));- }}- draggable={false}- onContextMenu={(e) => e.preventDefault()}- />+ {hasFileUrl && (+ <img+ src={currentPageData.file!}+ alt={`Page ${currentPage}`}+ className={cn(+ "max-h-[calc(100vh-120px)] max-w-full object-contain transition-opacity duration-200",+ imageLoaded ? "opacity-100" : "opacity-0",+ )}+ onLoad={handleImageLoad}+ onError={() => {+ setImageLoaded(true);+ setImageCache((prev) => ({ ...prev, [currentPage]: true }));+ }}+ draggable={false}+ onContextMenu={(e) => e.preventDefault()}+ />+ )}</div></div>diff --git a/components/documents/preview-viewers/preview-viewer.tsx b/components/documents/preview-viewers/preview-viewer.tsxindex 8ed9aba6..62f8eb7d 100644--- a/components/documents/preview-viewers/preview-viewer.tsx+++ b/components/documents/preview-viewers/preview-viewer.tsx@@ -1,3 +1,5 @@+import { useTeam } from "@/context/team-context";+import { DocumentPreviewData } from "@/lib/types/document-preview";import { PreviewExcelViewer } from "./preview-excel-viewer";@@ -10,11 +12,21 @@ interface PreviewViewerProps {}export function PreviewViewer({ documentData, onClose }: PreviewViewerProps) {+ const { currentTeamId } = useTeam();++ const previewPagesEndpoint = currentTeamId+ ? `/api/teams/${currentTeamId}/documents/${documentData.documentId}/preview-pages`+ : undefined;+const renderViewer = () => {// Documents with pages (PDFs, docs, slides)if (documentData.pages && documentData.pages.length > 0) {return (- <PreviewPagesViewer documentData={documentData} onClose={onClose} />+ <PreviewPagesViewer+ documentData={documentData}+ onClose={onClose}+ pagesApiEndpoint={previewPagesEndpoint}+ />);}diff --git a/components/view/dataroom/dataroom-document-view.tsx b/components/view/dataroom/dataroom-document-view.tsxindex 242621f2..5705fee4 100644--- a/components/view/dataroom/dataroom-document-view.tsx+++ b/components/view/dataroom/dataroom-document-view.tsx@@ -37,7 +37,7 @@ export type DEFAULT_DATAROOM_DOCUMENT_VIEW_TYPE = {file?: string | null;pages?:| {- file: string;+ file: string | null;pageNumber: string;embeddedLinks: string[];pageLinks: {diff --git a/components/view/document-view.tsx b/components/view/document-view.tsxindex 166f8f12..90a413ff 100644--- a/components/view/document-view.tsx+++ b/components/view/document-view.tsx@@ -32,7 +32,7 @@ export type DEFAULT_DOCUMENT_VIEW_TYPE = {file?: string | null;pages?:| {- file: string;+ file: string | null;pageNumber: string;embeddedLinks: string[];pageLinks: {diff --git a/components/view/view-data.tsx b/components/view/view-data.tsxindex 7411a985..96d39b39 100644--- a/components/view/view-data.tsx+++ b/components/view/view-data.tsx@@ -14,6 +14,7 @@ import {} from "@prisma/client";import { ExtendedRecordMap } from "notion-types";+import { useLazyPages } from "@/lib/hooks/use-lazy-pages";import {LinkWithDataroomDocument,LinkWithDocument,@@ -88,6 +89,14 @@ export default function ViewData({}) {const { isMobile } = useMediaQuery();+ const documentVersionId = document.versions[0]?.id;++ const { pages: lazyPages, ensurePagesLoaded } = useLazyPages({+ initialPages: viewData.pages ?? [],+ viewId: viewData.viewId,+ documentVersionId: documentVersionId,+ });+const navData: TNavData = {viewId: viewData.viewId,isPreview: viewData.isPreview,@@ -185,7 +194,7 @@ export default function ViewData({/>) : viewData.pages && !document.versions[0].isVertical ? (<PagesHorizontalViewer- pages={viewData.pages}+ pages={lazyPages}feedbackEnabled={link.enableFeedback!}screenshotProtectionEnabled={link.enableScreenshotProtection!}versionNumber={document.versions[0].versionNumber}@@ -202,10 +211,11 @@ export default function ViewData({ipAddress={viewData.ipAddress}linkName={link.name ?? `Link #${link.id.slice(-5)}`}navData={navData}+ ensurePagesLoaded={ensurePagesLoaded}/>) : viewData.pages && document.versions[0].isVertical ? (<PagesVerticalViewer- pages={viewData.pages}+ pages={lazyPages}feedbackEnabled={link.enableFeedback!}screenshotProtectionEnabled={link.enableScreenshotProtection!}versionNumber={document.versions[0].versionNumber}@@ -221,6 +231,7 @@ export default function ViewData({ipAddress={viewData.ipAddress}linkName={link.name ?? `Link #${link.id.slice(-5)}`}navData={navData}+ ensurePagesLoaded={ensurePagesLoaded}/>) : viewData.fileType === "video" ? (<VideoViewerdiff --git a/components/view/viewer/pages-horizontal-viewer.tsx b/components/view/viewer/pages-horizontal-viewer.tsxindex 458627b8..25b2ed0d 100644--- a/components/view/viewer/pages-horizontal-viewer.tsx+++ b/components/view/viewer/pages-horizontal-viewer.tsx@@ -40,9 +40,10 @@ export default function PagesHorizontalViewer({ipAddress,linkName,navData,+ ensurePagesLoaded,}: {pages: {- file: string;+ file: string | null;pageNumber: string;embeddedLinks: string[];pageLinks: {@@ -68,6 +69,7 @@ export default function PagesHorizontalViewer({ipAddress?: string;linkName?: string;navData: TNavData;+ ensurePagesLoaded?: (currentPage: number) => void;}) {const { isMobile, isPreview, linkId, documentId, viewId, dataroomId, brand } =navData;@@ -354,8 +356,13 @@ export default function PagesHorizontalViewer({index < DEFAULT_PRELOADED_IMAGES_NUM ? true : loaded,),);+ ensurePagesLoaded?.(1);}, []); // Run once on mount+ useEffect(() => {+ ensurePagesLoaded?.(pageNumber);+ }, [pageNumber, ensurePagesLoaded]);+useEffect(() => {// Remove token and email query parameters on component mountconst removeQueryParams = (queries: string[]) => {@@ -693,7 +700,7 @@ export default function PagesHorizontalViewer({}}useMap={`#page-map-${index + 1}`}src={- loadedImages[index]+ loadedImages[index] && page.file? page.file: "https://www.papermark.com/_static/blank.gif"}diff --git a/components/view/viewer/pages-vertical-viewer.tsx b/components/view/viewer/pages-vertical-viewer.tsxindex 4d992283..adadb3f3 100644--- a/components/view/viewer/pages-vertical-viewer.tsx+++ b/components/view/viewer/pages-vertical-viewer.tsx@@ -66,9 +66,10 @@ export default function PagesVerticalViewer({ipAddress,linkName,navData,+ ensurePagesLoaded,}: {pages: {- file: string;+ file: string | null;pageNumber: string;embeddedLinks: string[];pageLinks: {@@ -93,6 +94,7 @@ export default function PagesVerticalViewer({ipAddress?: string;linkName?: string;navData: TNavData;+ ensurePagesLoaded?: (currentPage: number) => void;}) {const { linkId, documentId, viewId, isPreview, dataroomId, brand } = navData;@@ -374,8 +376,13 @@ export default function PagesVerticalViewer({index < DEFAULT_PRELOADED_IMAGES_NUM ? true : loaded,),);+ ensurePagesLoaded?.(1);}, []); // Run once on mount+ useEffect(() => {+ ensurePagesLoaded?.(pageNumber);+ }, [pageNumber, ensurePagesLoaded]);+useEffect(() => {// Remove token and email query parameters on component mountconst removeQueryParams = (queries: string[]) => {@@ -874,7 +881,7 @@ export default function PagesVerticalViewer({page.metadata.width: 600; // fallback height- if (!loadedImages[index]) {+ if (!loadedImages[index] || !page.file) {// Render a placeholder div with correct dimensions to preserve scroll heightreturn (<divdiff --git a/lib/hooks/use-lazy-pages.ts b/lib/hooks/use-lazy-pages.tsnew file mode 100644index 00000000..089ec9df--- /dev/null+++ b/lib/hooks/use-lazy-pages.ts@@ -0,0 +1,125 @@+import { useCallback, useEffect, useRef, useState } from "react";++type PageData = {+ file: string | null;+ pageNumber: string;+ embeddedLinks: string[];+ pageLinks: {+ href: string;+ coords: string;+ isInternal?: boolean;+ targetPage?: number;+ }[];+ metadata: { width: number; height: number; scaleFactor: number };+};++type FetchPagesResponse = {+ pages: { pageNumber: number; file: string }[];+};++type UseLazyPagesOptions = {+ initialPages: PageData[];+ viewId?: string;+ documentVersionId: string;+ preloadRadius?: number;+ apiEndpoint?: string;+};++const DEFAULT_PRELOAD_RADIUS = 5;++export function useLazyPages({+ initialPages,+ viewId,+ documentVersionId,+ preloadRadius = DEFAULT_PRELOAD_RADIUS,+ apiEndpoint = "/api/views/pages",+}: UseLazyPagesOptions) {+ const [pages, setPages] = useState<PageData[]>(initialPages);+ const pendingRef = useRef<Set<number>>(new Set());+ const abortControllerRef = useRef<AbortController | null>(null);++ useEffect(() => {+ setPages(initialPages);+ }, [initialPages]);++ const fetchPageUrls = useCallback(+ async (pageNumbers: number[]) => {+ const needed = pageNumbers.filter(+ (pn) =>+ pn >= 1 &&+ pn <= pages.length &&+ !pages[pn - 1]?.file &&+ !pendingRef.current.has(pn),+ );++ if (needed.length === 0) return;++ needed.forEach((pn) => pendingRef.current.add(pn));++ try {+ const response = await fetch(apiEndpoint, {+ method: "POST",+ headers: { "Content-Type": "application/json" },+ body: JSON.stringify({+ viewId,+ documentVersionId,+ pageNumbers: needed,+ }),+ });++ if (!response.ok) {+ needed.forEach((pn) => pendingRef.current.delete(pn));+ return;+ }++ const data: FetchPagesResponse = await response.json();++ setPages((prev) => {+ const updated = [...prev];+ for (const fetchedPage of data.pages) {+ const idx = fetchedPage.pageNumber - 1;+ if (idx >= 0 && idx < updated.length && updated[idx]) {+ updated[idx] = {+ ...updated[idx],+ file: fetchedPage.file,+ };+ }+ }+ return updated;+ });++ needed.forEach((pn) => pendingRef.current.delete(pn));+ } catch {+ needed.forEach((pn) => pendingRef.current.delete(pn));+ }+ },+ [pages.length, viewId, documentVersionId, apiEndpoint],+ );++ const ensurePagesLoaded = useCallback(+ (currentPage: number) => {+ const start = Math.max(1, currentPage - preloadRadius);+ const end = Math.min(pages.length, currentPage + preloadRadius);+ const needed: number[] = [];++ for (let i = start; i <= end; i++) {+ if (!pages[i - 1]?.file && !pendingRef.current.has(i)) {+ needed.push(i);+ }+ }++ if (needed.length > 0) {+ fetchPageUrls(needed);+ }+ },+ [pages, preloadRadius, fetchPageUrls],+ );++ useEffect(() => {+ return () => {+ abortControllerRef.current?.abort();+ };+ }, []);++ return { pages, ensurePagesLoaded, fetchPageUrls };+}diff --git a/lib/types/document-preview.ts b/lib/types/document-preview.tsindex c5b06132..986df9df 100644--- a/lib/types/document-preview.ts+++ b/lib/types/document-preview.ts@@ -7,7 +7,7 @@ export interface DocumentPreviewData {numPages: number;advancedExcelEnabled?: boolean;pages?: {- file: string;+ file: string | null;pageNumber: string;embeddedLinks: string[];pageLinks: {diff --git a/pages/api/teams/[teamId]/documents/[id]/preview-data.ts b/pages/api/teams/[teamId]/documents/[id]/preview-data.tsindex 4c86716c..e3aa5a45 100644--- a/pages/api/teams/[teamId]/documents/[id]/preview-data.ts+++ b/pages/api/teams/[teamId]/documents/[id]/preview-data.ts@@ -107,15 +107,22 @@ export default async function handle(sheetData: undefined as any,};+ const INITIAL_PAGES_TO_LOAD = 10;+// Handle different file typesif (primaryVersion.hasPages && primaryVersion.pages.length > 0) {// Documents with pages (PDFs, docs, slides)+ // Only sign URLs for the first batch of pages to avoid timeouts on large documents.+ // Remaining page URLs are fetched on-demand by the client via preview-pages endpoint.returnData.pages = await Promise.all(- primaryVersion.pages.map(async (page) => {+ primaryVersion.pages.map(async (page, index) => {const { storageType, ...otherPageData } = page;return {...otherPageData,- file: await getFile({ data: page.file, type: storageType }),+ file:+ index < INITIAL_PAGES_TO_LOAD+ ? await getFile({ data: page.file, type: storageType })+ : null,};}),);diff --git a/pages/api/teams/[teamId]/documents/[id]/preview-pages.ts b/pages/api/teams/[teamId]/documents/[id]/preview-pages.tsnew file mode 100644index 00000000..6738141a--- /dev/null+++ b/pages/api/teams/[teamId]/documents/[id]/preview-pages.ts@@ -0,0 +1,113 @@+import { NextApiRequest, NextApiResponse } from "next";++import { getServerSession } from "next-auth/next";++import { getFile } from "@/lib/files/get-file";+import prisma from "@/lib/prisma";+import { CustomUser } from "@/lib/types";+import { log } from "@/lib/utils";++import { authOptions } from "../../../../auth/[...nextauth]";++const MAX_PAGES_PER_REQUEST = 50;++export default async function handle(+ req: NextApiRequest,+ res: NextApiResponse,+) {+ if (req.method !== "POST") {+ res.setHeader("Allow", ["POST"]);+ return res.status(405).end(`Method ${req.method} Not Allowed`);+ }++ const session = await getServerSession(req, res, authOptions);+ if (!session) {+ return res.status(401).json({ message: "Unauthorized" });+ }++ const { id: documentId, teamId } = req.query as {+ id: string;+ teamId: string;+ };+ const userId = (session.user as CustomUser).id;++ const { pageNumbers } = req.body as { pageNumbers: number[] };++ if (!pageNumbers || pageNumbers.length === 0) {+ return res.status(400).json({ message: "pageNumbers is required" });+ }++ if (pageNumbers.length > MAX_PAGES_PER_REQUEST) {+ return res.status(400).json({+ message: `Cannot request more than ${MAX_PAGES_PER_REQUEST} pages at once.`,+ });+ }++ try {+ const team = await prisma.team.findUnique({+ where: {+ id: teamId,+ users: {+ some: { userId },+ },+ },+ });++ if (!team) {+ return res.status(403).json({ message: "Access denied" });+ }++ const document = await prisma.document.findUnique({+ where: { id: documentId },+ select: {+ teamId: true,+ versions: {+ where: { isPrimary: true },+ select: { id: true },+ take: 1,+ },+ },+ });++ if (!document || document.teamId !== teamId) {+ return res.status(403).json({ message: "Access denied" });+ }++ const primaryVersion = document.versions[0];+ if (!primaryVersion) {+ return res.status(404).json({ message: "Document version not found" });+ }++ const documentPages = await prisma.documentPage.findMany({+ where: {+ versionId: primaryVersion.id,+ pageNumber: { in: pageNumbers },+ },+ select: {+ file: true,+ storageType: true,+ pageNumber: true,+ },+ });++ const pagesWithUrls = await Promise.all(+ documentPages.map(async (page) => {+ const { storageType, ...otherPage } = page;+ return {+ pageNumber: otherPage.pageNumber,+ file: await getFile({ data: page.file, type: storageType }),+ };+ }),+ );++ return res.status(200).json({ pages: pagesWithUrls });+ } catch (error) {+ log({+ message: "Error fetching preview page URLs",+ type: "error",+ mention: true,+ });+ console.error(error);+ return res.status(500).json({ message: "Internal server error" });+ }+}