Skip to content

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

feat: add page preview in hover

Marc Seitzdd3777240d5d
diff --git a/components/charts/bar-chart-tooltip.tsx b/components/charts/bar-chart-tooltip.tsx
new file mode 100644
index 00000000..9fd74fd9
--- /dev/null
+++ b/components/charts/bar-chart-tooltip.tsx
@@ -0,0 +1,59 @@
+import { getColorForVersion, timeFormatter } from "./utils";
+import { useDocumentThumbnail } from "@/lib/swr/use-document";
+import { useRouter } from "next/router";
+
+const CustomTooltip = ({
+ payload,
+ active,
+}: {
+ payload: any;
+ active: boolean | undefined;
+}) => {
+ if (!active || !payload) return null;
+
+ const router = useRouter();
+ const { id: documentId } = router.query as { id: string };
+ const pageNumber = parseInt(payload[0].payload.pageNumber);
+ const { data, error } = useDocumentThumbnail(pageNumber, documentId);
+
+ const imageUrl = data && !error ? data.imageUrl : null;
+
+ return (
+ <>
+ <div className="bg-tremor-background dark:bg-dark-tremor-background border border-tremor-border dark:border-dark-tremor-border rounded-md w-52 text-sm leading-6">
+ <div className="py-2 px-2.5 bg-tremor-background dark:bg-dark-tremor-background border-b border-tremor-border dark:border-dark-tremor-border rounded-t-md">
+ <p className="text-tremor-content dark:text-dark-tremor-content font-medium">
+ Page {payload[0].payload.pageNumber}
+ </p>
+ {imageUrl ? (
+ <img
+ src={imageUrl}
+ alt={`Page ${payload[0].payload.pageNumber} Thumbnail`}
+ />
+ ) : null}
+ </div>
+ {payload.map((item: any, idx: number) => (
+ <div
+ className="py-2 px-2.5 justify-between items-center w-full flex space-x-4"
+ key={idx}
+ >
+ <div className="whitespace-nowrap overflow-hidden text-overflow-ellipsis items-center flex space-x-2">
+ <span
+ className={`bg-${getColorForVersion(item.dataKey)}-500 rounded-full flex-shrink-0 w-2.5 h-2.5`}
+ aria-hidden="true"
+ ></span>
+ <p className="text-tremor-content dark:text-dark-tremor-content whitespace-nowrap overflow-hidden text-overflow-ellipsis">
+ {item.dataKey}
+ </p>
+ </div>
+ <p className="text-tremor-content-emphasis dark:text-dark-tremor-content-emphasis font-medium">
+ {timeFormatter(item.value)}
+ </p>
+ </div>
+ ))}
+ </div>
+ </>
+ );
+};
+
+export default CustomTooltip;
diff --git a/components/charts/bar-chart.tsx b/components/charts/bar-chart.tsx
index 23bd4fe6..df14efde 100644
--- a/components/charts/bar-chart.tsx
+++ b/components/charts/bar-chart.tsx
@@ -1,69 +1,13 @@
import { BarChart } from "@tremor/react";
import { useState } from "react";
-
-type Data = {
- pageNumber: string;
- data: {
- versionNumber: number;
- avg_duration: number;
- }[];
-};
-
-type SumData = {
- pageNumber: string;
- sum_duration: number;
-};
-
-type TransformedData = {
- pageNumber: string;
- [key: string]: number | string; // Adjusted type to accommodate version keys
-};
-
-type Color =
- | "neutral"
- | "emerald"
- | "gray"
- | "slate"
- | "zinc"
- | "stone"
- | "red"
- | "orange"
- | "amber"
- | "yellow"
- | "lime"
- | "green"
- | "teal"
- | "cyan"
- | "sky"
- | "blue"
- | "indigo"
- | "violet"
- | "purple"
- | "fuchsia"
- | "pink"
- | "rose"
- | "gray-300";
-
-const timeFormatter = (number: number) => {
- const totalSeconds = Math.floor(number / 1000);
- const minutes = Math.floor(totalSeconds / 60);
- const seconds = Math.round(totalSeconds % 60);
-
- // Adding zero padding if seconds less than 10
- const secondsFormatted = seconds < 10 ? `0${seconds}` : `${seconds}`;
-
- return `${minutes}:${secondsFormatted}`;
-};
-
-// const renameAvgDurationKey = (data: any[]) => {
-// return data.map((item) => {
-// return {
-// ...item,
-// "Time spent per page": item.avg_duration,
-// avg_duration: undefined,
-// };
-// });
-// };
+import {
+ type Data,
+ type SumData,
+ type TransformedData,
+ getColors,
+ timeFormatter,
+} from "./utils";
+import CustomTooltip from "./bar-chart-tooltip";
const renameDummyDurationKey = (data: Data[]): TransformedData[] => {
return data.reduce((acc, { pageNumber, data }) => {
@@ -112,36 +56,6 @@ const getVersionNumbers = (data: TransformedData[]) => {
];
};
-const getColors = (versionNumbers: string[]): Color[] => {
- const colorArray = [
- "emerald",
- "teal",
- "gray",
- "orange",
- "zinc",
- "neutral",
- "stone",
- "red",
- "amber",
- "yellow",
- "lime",
- "green",
- "cyan",
- "sky",
- "blue",
- "indigo",
- "violet",
- "purple",
- "fuchsia",
- "pink",
- "rose",
- ];
- return versionNumbers.map((versionNumber: string) => {
- const versionIndex = parseInt(versionNumber.split(" ")[1]) - 1;
- return colorArray[versionIndex % colorArray.length] as Color;
- });
-};
-
export default function BarChartComponent({
data,
isSum = false,
@@ -192,6 +106,7 @@ export default function BarChartComponent({
yAxisWidth={50}
showGridLines={false}
onValueChange={(v) => setValue(v)}
+ customTooltip={isDummy ? undefined : CustomTooltip}
/>
);
}
diff --git a/components/charts/utils.ts b/components/charts/utils.ts
new file mode 100644
index 00000000..aee6c1ee
--- /dev/null
+++ b/components/charts/utils.ts
@@ -0,0 +1,117 @@
+export type Data = {
+ pageNumber: string;
+ data: {
+ versionNumber: number;
+ avg_duration: number;
+ }[];
+};
+
+export type SumData = {
+ pageNumber: string;
+ sum_duration: number;
+};
+
+export type TransformedData = {
+ pageNumber: string;
+ [key: string]: number | string; // Adjusted type to accommodate version keys
+};
+
+export type CustomTooltipTypeBar = {
+ payload: any;
+ active: boolean | undefined;
+ label: any;
+};
+
+export type Color =
+ | "neutral"
+ | "emerald"
+ | "gray"
+ | "slate"
+ | "zinc"
+ | "stone"
+ | "red"
+ | "orange"
+ | "amber"
+ | "yellow"
+ | "lime"
+ | "green"
+ | "teal"
+ | "cyan"
+ | "sky"
+ | "blue"
+ | "indigo"
+ | "violet"
+ | "purple"
+ | "fuchsia"
+ | "pink"
+ | "rose"
+ | "gray-300";
+
+export const getColors = (versionNumbers: string[]): Color[] => {
+ const colorArray = [
+ "emerald",
+ "teal",
+ "gray",
+ "orange",
+ "zinc",
+ "neutral",
+ "stone",
+ "red",
+ "amber",
+ "yellow",
+ "lime",
+ "green",
+ "cyan",
+ "sky",
+ "blue",
+ "indigo",
+ "violet",
+ "purple",
+ "fuchsia",
+ "pink",
+ "rose",
+ ];
+ return versionNumbers.map((versionNumber: string) => {
+ const versionIndex = parseInt(versionNumber.split(" ")[1]) - 1;
+ return colorArray[versionIndex % colorArray.length] as Color;
+ });
+};
+
+export const getColorForVersion = (versionNumber: string): Color => {
+ const versionIndex = parseInt(versionNumber.split(" ")[1]) - 1;
+ const colorArray = [
+ "emerald",
+ "teal",
+ "gray",
+ "orange",
+ "zinc",
+ "neutral",
+ "stone",
+ "red",
+ "amber",
+ "yellow",
+ "lime",
+ "green",
+ "cyan",
+ "sky",
+ "blue",
+ "indigo",
+ "violet",
+ "purple",
+ "fuchsia",
+ "pink",
+ "rose",
+ ];
+ return colorArray[versionIndex % colorArray.length] as Color;
+};
+
+export const timeFormatter = (number: number) => {
+ const totalSeconds = Math.floor(number / 1000);
+ const minutes = Math.floor(totalSeconds / 60);
+ const seconds = Math.round(totalSeconds % 60);
+
+ // Adding zero padding if seconds less than 10
+ const secondsFormatted = seconds < 10 ? `0${seconds}` : `${seconds}`;
+
+ return `${minutes}:${secondsFormatted}`;
+};
diff --git a/lib/documents/get-file-helper.ts b/lib/documents/get-file-helper.ts
new file mode 100644
index 00000000..c6a54355
--- /dev/null
+++ b/lib/documents/get-file-helper.ts
@@ -0,0 +1,53 @@
+import { getFile } from "@/lib/files/get-file";
+import prisma from "@/lib/prisma";
+
+export const getFileForDocumentPage = async (
+ pageNumber: number,
+ documentId: string,
+): Promise<string> => {
+ const documentVersions = await prisma.documentVersion.findMany({
+ where: {
+ documentId: documentId,
+ isPrimary: true,
+ },
+ select: {
+ id: true,
+ },
+ orderBy: {
+ versionNumber: "desc",
+ },
+ take: 1,
+ });
+
+ if (documentVersions.length === 0) {
+ throw new Error(
+ `Latest document version from document id ${documentId} with document id ${documentId} not found`,
+ );
+ }
+
+ const documentVersion = documentVersions[0];
+
+ const documentPage = await prisma.documentPage.findUnique({
+ where: {
+ pageNumber_versionId: {
+ pageNumber: pageNumber,
+ versionId: documentVersion.id,
+ },
+ },
+ select: {
+ file: true,
+ storageType: true,
+ },
+ });
+
+ if (!documentPage) {
+ throw new Error(
+ `Document page ${pageNumber} with version id ${documentId} not found`,
+ );
+ }
+
+ return getFile({
+ type: documentPage.storageType,
+ data: documentPage.file,
+ });
+};
diff --git a/lib/swr/use-document.ts b/lib/swr/use-document.ts
index 64ed8bb7..6df65b46 100644
--- a/lib/swr/use-document.ts
+++ b/lib/swr/use-document.ts
@@ -1,5 +1,6 @@
import { useRouter } from "next/router";
import useSWR from "swr";
+import useSWRImmutable from "swr/immutable";
import { fetcher } from "@/lib/utils";
import { DocumentWithVersion, LinkWithViews } from "@/lib/types";
import { Document, View } from "@prisma/client";
@@ -122,3 +123,23 @@ export function useDocumentProcessingStatus(documentVersionId: string) {
error: error,
};
}
+
+export function useDocumentThumbnail(pageNumber: number, documentId: string) {
+ const { data, error } = useSWR<{ imageUrl: string }>(
+ `/api/jobs/get-thumbnail?documentId=${documentId}&pageNumber=${pageNumber}`,
+ fetcher,
+ {
+ dedupingInterval: 1200000,
+ revalidateOnFocus: false,
+ // revalidateOnMount: false,
+ revalidateIfStale: false,
+ refreshInterval: 0,
+ },
+ );
+
+ return {
+ data,
+ loading: !error && !data,
+ error,
+ };
+}
diff --git a/pages/api/jobs/get-thumbnail.ts b/pages/api/jobs/get-thumbnail.ts
new file mode 100644
index 00000000..2de400cf
--- /dev/null
+++ b/pages/api/jobs/get-thumbnail.ts
@@ -0,0 +1,37 @@
+import { NextApiRequest, NextApiResponse } from "next";
+import { getFileForDocumentPage } from "@/lib/documents/get-file-helper";
+import { getServerSession } from "next-auth";
+import { authOptions } from "../auth/[...nextauth]";
+
+export default async function handle(
+ req: NextApiRequest,
+ res: NextApiResponse,
+) {
+ // We only allow GET requests
+ if (req.method !== "GET") {
+ res.status(405).json({ message: "Method Not Allowed" });
+ return;
+ }
+
+ const session = await getServerSession(req, res, authOptions);
+ if (!session) {
+ return res.status(401).end("Unauthorized");
+ }
+
+ const { documentId, pageNumber } = req.query as {
+ documentId: string;
+ pageNumber: string;
+ };
+
+ try {
+ const imageUrl = await getFileForDocumentPage(
+ Number(pageNumber),
+ documentId,
+ );
+
+ return res.status(200).json({ imageUrl });
+ } catch (error) {
+ res.status(500).json({ message: (error as Error).message });
+ return;
+ }
+}
diff --git a/tailwind.config.js b/tailwind.config.js
index 70a68495..830498f2 100644
--- a/tailwind.config.js
+++ b/tailwind.config.js
@@ -55,37 +55,37 @@ module.exports = {
//** START: TREMOR **//
// light mode
- // tremor: {
- // brand: {
- // faint: "#eff6ff", // blue-50
- // muted: "#bfdbfe", // blue-200
- // subtle: "#60a5fa", // blue-400
- // DEFAULT: "#3b82f6", // blue-500
- // emphasis: "#1d4ed8", // blue-700
- // inverted: "#ffffff", // white
- // },
- // background: {
- // muted: "#f9fafb", // gray-50
- // subtle: "#f3f4f6", // gray-100
- // DEFAULT: "#ffffff", // white
- // emphasis: "#374151", // gray-700
- // },
- // border: {
- // DEFAULT: "#e5e7eb", // gray-200
- // },
- // ring: {
- // DEFAULT: "#e5e7eb", // gray-200
- // },
- // content: {
- // subtle: "#9ca3af", // gray-400
- // DEFAULT: "#6b7280", // gray-500
- // emphasis: "#374151", // gray-700
- // strong: "#111827", // gray-900
- // inverted: "#ffffff", // white
- // },
- // },
- // dark mode
tremor: {
+ brand: {
+ faint: "#eff6ff", // blue-50
+ muted: "#bfdbfe", // blue-200
+ subtle: "#60a5fa", // blue-400
+ DEFAULT: "#3b82f6", // blue-500
+ emphasis: "#1d4ed8", // blue-700
+ inverted: "#ffffff", // white
+ },
+ background: {
+ muted: "#f9fafb", // gray-50
+ subtle: "#f3f4f6", // gray-100
+ DEFAULT: "#ffffff", // white
+ emphasis: "#374151", // gray-700
+ },
+ border: {
+ DEFAULT: "#e5e7eb", // gray-200
+ },
+ ring: {
+ DEFAULT: "#e5e7eb", // gray-200
+ },
+ content: {
+ subtle: "#9ca3af", // gray-400
+ DEFAULT: "#6b7280", // gray-500
+ emphasis: "#374151", // gray-700
+ strong: "#111827", // gray-900
+ inverted: "#ffffff", // white
+ },
+ },
+ // dark mode
+ "dark-tremor": {
brand: {
faint: "#0B1229", // custom
muted: "#172554", // blue-950
@@ -119,17 +119,17 @@ module.exports = {
boxShadow: {
//** START: TREMOR boxShadow **//
// light
- // "tremor-input": "0 1px 2px 0 rgb(0 0 0 / 0.05)",
- // "tremor-card":
- // "0 1px 3px 0 rgb(0 0 0 / 0.1), 0 1px 2px -1px rgb(0 0 0 / 0.1)",
- // "tremor-dropdown":
- // "0 4px 6px -1px rgb(0 0 0 / 0.1), 0 2px 4px -2px rgb(0 0 0 / 0.1)",
- // dark
"tremor-input": "0 1px 2px 0 rgb(0 0 0 / 0.05)",
"tremor-card":
"0 1px 3px 0 rgb(0 0 0 / 0.1), 0 1px 2px -1px rgb(0 0 0 / 0.1)",
"tremor-dropdown":
"0 4px 6px -1px rgb(0 0 0 / 0.1), 0 2px 4px -2px rgb(0 0 0 / 0.1)",
+ // dark
+ "dark-tremor-input": "0 1px 2px 0 rgb(0 0 0 / 0.05)",
+ "dark-tremor-card":
+ "0 1px 3px 0 rgb(0 0 0 / 0.1), 0 1px 2px -1px rgb(0 0 0 / 0.1)",
+ "dark-tremor-dropdown":
+ "0 4px 6px -1px rgb(0 0 0 / 0.1), 0 2px 4px -2px rgb(0 0 0 / 0.1)",
//** END: TREMOR boxShadow **//
},
borderRadius: {