Skip to content

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

feat: add visitor time and sign up

Marc Seitzb7a2bd2b9c9a
diff --git a/components/view/PagesViewerNew.tsx b/components/view/PagesViewerNew.tsx
index 9e0e329b..42519f52 100644
--- a/components/view/PagesViewerNew.tsx
+++ b/components/view/PagesViewerNew.tsx
@@ -10,6 +10,7 @@ import {
ChevronRightIcon,
ChevronUpIcon,
} from "lucide-react";
+import { useSession } from "next-auth/react";
import {
ReactZoomPanPinchContentRef,
TransformComponent,
@@ -25,6 +26,7 @@ import Nav from "./nav";
import { PoweredBy } from "./powered-by";
import Question from "./question";
import Toolbar from "./toolbar";
+import ViewDurationSummary from "./visitor-graph";
const DEFAULT_PRELOADED_IMAGES_NUM = 5;
@@ -36,7 +38,18 @@ const trackPageView = async (data: {
pageNumber: number;
versionNumber: number;
dataroomId?: string;
+ setViewedPages?: React.Dispatch<
+ React.SetStateAction<{ pageNumber: number; duration: number }[]>
+ >;
}) => {
+ data.setViewedPages &&
+ data.setViewedPages((prevViewedPages) =>
+ prevViewedPages.map((page) =>
+ page.pageNumber === data.pageNumber
+ ? { ...page, duration: page.duration + data.duration }
+ : page,
+ ),
+ );
await fetch("/api/record_view", {
method: "POST",
body: JSON.stringify(data),
@@ -64,6 +77,7 @@ export default function PagesViewer({
enableQuestion = false,
feedback,
isVertical = false,
+ viewerEmail,
}: {
pages: { file: string; pageNumber: string; embeddedLinks: string[] }[];
linkId: string;
@@ -85,13 +99,20 @@ export default function PagesViewer({
data: { question: string; type: string };
} | null;
isVertical?: boolean;
+ viewerEmail?: string;
}) {
const router = useRouter();
+ const { status: sessionStatus } = useSession();
const numPages = pages.length;
const numPagesWithFeedback =
enableQuestion && feedback ? numPages + 1 : numPages;
+ const numPagesWithAccountCreation =
+ sessionStatus === "authenticated" && !dataroomId
+ ? numPagesWithFeedback
+ : numPagesWithFeedback + 1;
+
const pageQuery = router.query.p ? Number(router.query.p) : 1;
const [pageNumber, setPageNumber] = useState<number>(() =>
@@ -103,8 +124,17 @@ export default function PagesViewer({
);
const [submittedFeedback, setSubmittedFeedback] = useState<boolean>(false);
+ const [accountCreated, setAccountCreated] = useState<boolean>(false);
const [scale, setScale] = useState<number>(1);
+ const initialViewedPages = Array.from({ length: numPages }, (_, index) => ({
+ pageNumber: index + 1,
+ duration: 0,
+ }));
+
+ const [viewedPages, setViewedPages] =
+ useState<{ pageNumber: number; duration: number }[]>(initialViewedPages);
+
const startTimeRef = useRef(Date.now());
const pageNumberRef = useRef<number>(pageNumber);
const visibilityRef = useRef<boolean>(true);
@@ -123,6 +153,8 @@ export default function PagesViewer({
useEffect(() => {
const handleVisibilityChange = () => {
+ if (pageNumber > numPages) return;
+
if (document.visibilityState === "visible") {
visibilityRef.current = true;
startTimeRef.current = Date.now(); // Reset start time when the page becomes visible again
@@ -135,9 +167,10 @@ export default function PagesViewer({
documentId,
viewId,
duration,
- pageNumber: pageNumberRef.current,
+ pageNumber: pageNumber,
versionNumber,
dataroomId,
+ setViewedPages,
});
}
}
@@ -153,38 +186,34 @@ export default function PagesViewer({
useEffect(() => {
startTimeRef.current = Date.now();
- return () => {
- if (
- visibilityRef.current &&
- pageNumber <= numPages &&
- pageNumberRef.current <= numPages
- ) {
- const duration = Date.now() - startTimeRef.current;
- trackPageView({
- linkId,
- documentId,
- viewId,
- duration,
- pageNumber: pageNumberRef.current,
- versionNumber,
- dataroomId,
- });
- }
- };
- }, [pageNumber, pageNumberRef.current, numPages]);
+ if (visibilityRef.current && pageNumber <= numPages) {
+ const duration = Date.now() - startTimeRef.current;
+ trackPageView({
+ linkId,
+ documentId,
+ viewId,
+ duration,
+ pageNumber: pageNumber,
+ versionNumber,
+ dataroomId,
+ setViewedPages,
+ });
+ }
+ }, [pageNumber, numPages]);
useEffect(() => {
const handleBeforeUnload = () => {
- if (pageNumber <= numPages && visibilityRef.current) {
+ if (pageNumber <= numPages) {
const duration = Date.now() - startTimeRef.current;
trackPageView({
linkId,
documentId,
viewId,
duration,
- pageNumber: pageNumberRef.current,
+ pageNumber: pageNumber,
versionNumber,
dataroomId,
+ setViewedPages,
});
}
};
@@ -246,7 +275,7 @@ export default function PagesViewer({
}
// Do not track the question page
- if (currentPage === numPages + 1) {
+ if (currentPage > numPages) {
setPageNumber(currentPage);
startTimeRef.current = Date.now();
return;
@@ -254,8 +283,8 @@ export default function PagesViewer({
// Scroll Down Tracking
if (
- currentPageFraction >= 0.8 &&
- currentPage === pageNumberRef.current &&
+ currentPageFraction > 0.5 &&
+ currentPage === pageNumber &&
!hasTrackedDownRef.current
) {
const duration = Date.now() - startTimeRef.current;
@@ -264,9 +293,10 @@ export default function PagesViewer({
documentId,
viewId,
duration,
- pageNumber: pageNumberRef.current,
+ pageNumber: pageNumber,
versionNumber,
dataroomId,
+ setViewedPages,
});
setPageNumber(currentPage);
pageNumberRef.current = currentPage;
@@ -274,22 +304,21 @@ export default function PagesViewer({
hasTrackedDownRef.current = true;
hasTrackedUpRef.current = false;
} else if (
- currentPageFraction >= 0.8 &&
- currentPage === pageNumberRef.current - 1 &&
+ currentPageFraction > 0.5 &&
+ currentPage === pageNumber - 1 &&
!hasTrackedDownRef.current
) {
const duration = Date.now() - startTimeRef.current;
- if (currentPage !== numPagesWithFeedback - 1) {
- trackPageView({
- linkId,
- documentId,
- viewId,
- duration,
- pageNumber: pageNumberRef.current,
- versionNumber,
- dataroomId,
- });
- }
+ trackPageView({
+ linkId,
+ documentId,
+ viewId,
+ duration,
+ pageNumber: pageNumber,
+ versionNumber,
+ dataroomId,
+ setViewedPages,
+ });
setPageNumber(currentPage);
pageNumberRef.current = currentPage;
startTimeRef.current = Date.now();
@@ -299,30 +328,29 @@ export default function PagesViewer({
// Scroll Up Tracking
if (
- currentPageFraction <= 0.2 &&
- currentPage === pageNumberRef.current &&
+ currentPageFraction <= 0.5 &&
+ currentPage === pageNumber &&
!hasTrackedUpRef.current
) {
const duration = Date.now() - startTimeRef.current;
- if (currentPage !== numPagesWithFeedback - 1) {
- trackPageView({
- linkId,
- documentId,
- viewId,
- duration,
- pageNumber: pageNumberRef.current,
- versionNumber,
- dataroomId,
- });
- }
+ trackPageView({
+ linkId,
+ documentId,
+ viewId,
+ duration,
+ pageNumber: pageNumber,
+ versionNumber,
+ dataroomId,
+ setViewedPages,
+ });
setPageNumber(currentPage);
pageNumberRef.current = currentPage;
startTimeRef.current = Date.now();
hasTrackedUpRef.current = true;
hasTrackedDownRef.current = false;
} else if (
- currentPageFraction <= 0.2 &&
- currentPage === pageNumberRef.current + 1 &&
+ currentPageFraction <= 0.5 &&
+ currentPage === pageNumber + 1 &&
!hasTrackedUpRef.current
) {
const duration = Date.now() - startTimeRef.current;
@@ -331,9 +359,10 @@ export default function PagesViewer({
documentId,
viewId,
duration,
- pageNumber: pageNumberRef.current + 1,
+ pageNumber: pageNumber + 1,
versionNumber,
dataroomId,
+ setViewedPages,
});
setPageNumber(currentPage);
pageNumberRef.current = currentPage;
@@ -385,34 +414,63 @@ export default function PagesViewer({
return;
}
+ if (pageNumber === numPagesWithFeedback + 1) {
+ if (isVertical) {
+ scrollActionRef.current = true;
+ const newScrollPosition =
+ (pageNumber - 2) * containerRef.current!.clientHeight;
+ containerRef.current?.scrollTo({
+ top: newScrollPosition,
+ behavior: "smooth",
+ });
+ }
+ setPageNumber(pageNumber - 1);
+ startTimeRef.current = Date.now();
+ return;
+ }
+
const duration = Date.now() - startTimeRef.current;
trackPageView({
linkId,
documentId,
viewId,
duration,
- pageNumber: pageNumberRef.current,
+ pageNumber: pageNumber,
versionNumber,
dataroomId,
+ setViewedPages,
});
- setPageNumber(pageNumber - 1);
- pageNumberRef.current = pageNumber - 1;
- startTimeRef.current = Date.now();
-
if (isVertical) {
scrollActionRef.current = true;
const newScrollPosition =
- (pageNumberRef.current - 1) * containerRef.current!.clientHeight;
+ (pageNumber - 2) * containerRef.current!.clientHeight;
containerRef.current?.scrollTo({
top: newScrollPosition,
behavior: "smooth",
});
}
+
+ // decrement page number
+ setPageNumber(pageNumber - 1);
+ startTimeRef.current = Date.now();
};
const goToNextPage = () => {
- if (pageNumberRef.current >= numPagesWithFeedback) {
+ if (pageNumber >= numPagesWithAccountCreation) return;
+
+ if (pageNumber > numPages) {
+ if (isVertical) {
+ scrollActionRef.current = true;
+ const newScrollPosition =
+ pageNumber * containerRef.current!.clientHeight;
+ containerRef.current?.scrollTo({
+ top: newScrollPosition,
+ behavior: "smooth",
+ });
+ }
+ setPageNumber(pageNumber + 1);
+ startTimeRef.current = Date.now();
return;
}
@@ -424,24 +482,24 @@ export default function PagesViewer({
documentId,
viewId,
duration,
- pageNumber: pageNumberRef.current,
+ pageNumber: pageNumber,
versionNumber,
dataroomId,
+ setViewedPages,
});
- setPageNumber(pageNumber + 1);
- pageNumberRef.current = pageNumber + 1;
- startTimeRef.current = Date.now();
-
if (isVertical) {
scrollActionRef.current = true;
- const newScrollPosition =
- (pageNumberRef.current - 1) * containerRef.current!.clientHeight;
+ const newScrollPosition = pageNumber * containerRef.current!.clientHeight;
containerRef.current?.scrollTo({
top: newScrollPosition,
behavior: "smooth",
});
}
+
+ // increment page number
+ setPageNumber(pageNumber + 1);
+ startTimeRef.current = Date.now();
};
const handleKeyDown = (event: KeyboardEvent) => {
@@ -514,7 +572,7 @@ export default function PagesViewer({
<>
<Nav
pageNumber={pageNumber}
- numPages={numPagesWithFeedback}
+ numPages={numPagesWithAccountCreation}
assistantEnabled={assistantEnabled}
allowDownload={allowDownload}
brand={brand}
@@ -540,7 +598,7 @@ export default function PagesViewer({
className={`flex ${isVertical ? "flex-col items-center" : "flex-row justify-center"} w-full`}
onContextMenu={handleContextMenu}
>
- {pageNumber <= numPagesWithFeedback &&
+ {pageNumber <= numPagesWithAccountCreation &&
pages.map((page, index) => (
<TransformWrapper
key={index}
@@ -592,6 +650,23 @@ export default function PagesViewer({
/>
</div>
) : null}
+
+ {sessionStatus !== "authenticated" &&
+ !dataroomId &&
+ (isVertical || pageNumber === numPagesWithAccountCreation) ? (
+ <div
+ className={cn("relative block h-screen w-full")}
+ style={{ height: "calc(100vh - 64px)" }}
+ >
+ <ViewDurationSummary
+ linkId={linkId}
+ viewedPages={viewedPages}
+ viewerEmail={viewerEmail}
+ accountCreated={accountCreated}
+ setAccountCreated={setAccountCreated}
+ />
+ </div>
+ ) : null}
</div>
</div>
@@ -600,10 +675,10 @@ export default function PagesViewer({
<div className="absolute bottom-4 left-1/2 -translate-x-1/2 transform">
<button
onClick={goToNextPage}
- disabled={pageNumber >= numPagesWithFeedback}
+ disabled={pageNumber >= numPagesWithAccountCreation}
className={cn(
"rounded-full bg-gray-950/50 p-1 hover:bg-gray-950/75",
- pageNumber >= numPagesWithFeedback && "hidden",
+ pageNumber >= numPagesWithAccountCreation && "hidden",
)}
>
<ChevronDownIcon className="h-10 w-10 text-white" />
@@ -640,10 +715,10 @@ export default function PagesViewer({
<div className="absolute right-4 top-1/2 -translate-y-1/2 transform">
<button
onClick={goToNextPage}
- disabled={pageNumber >= numPagesWithFeedback}
+ disabled={pageNumber >= numPagesWithAccountCreation}
className={cn(
"rounded-full bg-gray-950/50 p-1 hover:bg-gray-950/75",
- pageNumber >= numPagesWithFeedback && "hidden",
+ pageNumber >= numPagesWithAccountCreation && "hidden",
)}
>
<ChevronRightIcon className="h-10 w-10 text-white" />
@@ -651,7 +726,7 @@ export default function PagesViewer({
</div>
</>
)}
- {feedbackEnabled && pageNumber !== numPages + 1 ? (
+ {feedbackEnabled && pageNumber <= numPages ? (
<Toolbar viewId={viewId} pageNumber={pageNumber} />
) : null}
{screenshotProtectionEnabled ? <ScreenProtector /> : null}
diff --git a/components/view/document-view.tsx b/components/view/document-view.tsx
index 270562e4..6dfd91cb 100644
--- a/components/view/document-view.tsx
+++ b/components/view/document-view.tsx
@@ -213,6 +213,7 @@ export default function DocumentView({
notionData={notionData}
brand={brand}
showPoweredByBanner={showPoweredByBanner}
+ viewerEmail={data.email ?? verifiedEmail ?? userEmail ?? undefined}
/>
) : (
<div className="flex h-screen items-center justify-center">
diff --git a/components/view/view-data.tsx b/components/view/view-data.tsx
index ab8c7c1b..c1ae488a 100644
--- a/components/view/view-data.tsx
+++ b/components/view/view-data.tsx
@@ -21,6 +21,7 @@ export default function ViewData({
notionData,
brand,
showPoweredByBanner,
+ viewerEmail,
}: {
viewData: DEFAULT_DOCUMENT_VIEW_TYPE;
link: LinkWithDocument;
@@ -30,6 +31,7 @@ export default function ViewData({
};
brand?: Partial<Brand> | null;
showPoweredByBanner?: boolean;
+ viewerEmail?: string;
}) {
const { document } = link;
@@ -69,6 +71,7 @@ export default function ViewData({
enableQuestion={link.enableQuestion}
feedback={link.feedback}
isVertical={document.versions[0].isVertical}
+ viewerEmail={viewerEmail}
/>
) : (
<PDFViewer
diff --git a/components/view/visitor-graph.tsx b/components/view/visitor-graph.tsx
new file mode 100644
index 00000000..342f5331
--- /dev/null
+++ b/components/view/visitor-graph.tsx
@@ -0,0 +1,208 @@
+import Link from "next/link";
+
+import { useState } from "react";
+
+import { BarChart } from "@tremor/react";
+import { motion } from "framer-motion";
+import { signIn } from "next-auth/react";
+
+import { useAnalytics } from "@/lib/analytics";
+import { STAGGER_CHILD_VARIANTS } from "@/lib/constants";
+
+import { timeFormatter } from "../charts/utils";
+import { Button } from "../ui/button";
+import { Input } from "../ui/input";
+import { Label } from "../ui/label";
+
+function formatTotalDuration(totalDuration: number | null | undefined): string {
+ if (totalDuration == null) {
+ return "0 minutes"; // Default value if total_duration is null
+ } else if (totalDuration < 60000) {
+ return "< 1 minute";
+ } else {
+ const minutes = Math.ceil(totalDuration / 60000);
+ return `${minutes} minutes`;
+ }
+}
+
+function sumDurationsAndFormat(
+ pages: {
+ pageNumber: number;
+ duration: number;
+ }[],
+): string {
+ const totalDuration = pages.reduce((sum, page) => sum + page.duration, 0);
+ return formatTotalDuration(totalDuration);
+}
+
+export default function ViewDurationSummary({
+ linkId,
+ viewedPages,
+ viewerEmail,
+ accountCreated,
+ setAccountCreated,
+}: {
+ linkId: string;
+ viewedPages: { pageNumber: number; duration: number }[];
+ viewerEmail?: string;
+ accountCreated: boolean;
+ setAccountCreated: React.Dispatch<React.SetStateAction<boolean>>;
+}) {
+ const [email, setEmail] = useState<string>(viewerEmail || "");
+ const [loading, setLoading] = useState<boolean>(false);
+
+ const analytics = useAnalytics();
+
+ if (accountCreated) {
+ return (
+ <motion.div
+ className="mx-5 flex h-full flex-col items-center justify-center space-y-10 text-center sm:mx-auto"
+ variants={{
+ hidden: { opacity: 0, scale: 0.95 },
+ show: {
+ opacity: 1,
+ scale: 1,
+ transition: {
+ staggerChildren: 0.2,
+ },
+ },
+ }}
+ initial="hidden"
+ animate="show"
+ exit="hidden"
+ transition={{ duration: 0.3, type: "spring" }}
+ >
+ <motion.div
+ variants={STAGGER_CHILD_VARIANTS}
+ className="flex flex-col items-center space-y-10 text-center"
+ >
+ <h1 className="max-w-lg text-3xl font-semibold text-white transition-colors">
+ Thanks for creating an account!
+ </h1>
+ <p className="max-w-lg text-balance text-white">
+ We sent you an email confirmation with a link to your Papermark
+ account.
+ </p>
+ </motion.div>
+ </motion.div>
+ );
+ }
+
+ return (
+ <motion.div
+ className="flex h-full w-full flex-col items-center justify-center space-y-10 text-center"
+ variants={{
+ hidden: { opacity: 0, scale: 0.95 },
+ show: {
+ opacity: 1,
+ scale: 1,
+ transition: {
+ staggerChildren: 0.2,
+ },
+ },
+ }}
+ initial="hidden"
+ animate="show"
+ exit="hidden"
+ transition={{ duration: 0.3, type: "spring" }}
+ >
+ <motion.div
+ variants={STAGGER_CHILD_VARIANTS}
+ className="mx-5 h-fit w-full max-w-md overflow-hidden rounded-md bg-white py-6 text-white sm:mx-0"
+ >
+ <motion.div
+ variants={STAGGER_CHILD_VARIANTS}
+ className="flex flex-col items-center space-y-10 text-center"
+ >
+ <div className="flex flex-col items-center justify-center space-y-3 px-4 py-6 pt-8 text-center sm:px-16">
+ <div className="text-balance text-base text-muted-foreground">
+ You spent {sumDurationsAndFormat(viewedPages)} on this document.
+ </div>
+ <BarChart
+ className="h-40"
+ data={viewedPages}
+ index="pageNumber"
+ categories={["duration"]}
+ colors={["emerald"]}
+ valueFormatter={(v) => timeFormatter(v)}
+ showYAxis={false}
+ showGridLines={true}
+ showLegend={false}
+ />
+ </div>
+ </motion.div>
+ <motion.div variants={STAGGER_CHILD_VARIANTS}>
+ <div className="flex flex-col items-center justify-center space-y-3 px-4 py-6 pt-8 text-center sm:px-16">
+ <div className="text-balance text-2xl font-semibold text-gray-800">
+ Start sharing documents and data rooms securely
+ </div>
+ </div>
+ <form
+ className="flex flex-col gap-4 px-4 sm:px-16"
+ onSubmit={(e) => {
+ e.preventDefault();
+ setLoading(true);
+ signIn("email", {
+ email: email,
+ redirect: false,
+ callbackUrl: `/documents`,
+ }).then((res) => {
+ if (res?.ok && !res?.error) {
+ setEmail("");
+ setAccountCreated(true);
+ analytics.capture("Account Created", {
+ email: email,
+ linkId: linkId,
+ timeSpent: viewedPages.reduce(
+ (sum, page) => sum + page.duration,
+ 0,
+ ),
+ });
+ }
+ setLoading(false);
+ });
+ }}
+ >
+ <Label className="sr-only" htmlFor="email">
+ Email
+ </Label>
+ <Input
+ id="email"
+ placeholder="[email protected]"
+ type="email"
+ autoCapitalize="none"
+ autoComplete="email"
+ autoCorrect="off"
+ data-1p-ignore
+ disabled={loading}
+ value={email}
+ onChange={(e) => setEmail(e.target.value)}
+ className="flex h-10 w-full rounded-md border-0 bg-background bg-white px-3 py-2 text-sm text-gray-900 ring-1 ring-gray-200 transition-colors file:border-0 file:bg-transparent file:text-sm file:font-medium placeholder:text-muted-foreground focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring disabled:cursor-not-allowed disabled:opacity-50"
+ />
+ <Button
+ type="submit"
+ loading={loading}
+ className={`${
+ loading ? "bg-black" : "bg-gray-800 hover:bg-gray-900"
+ } focus:shadow-outline transform rounded px-4 py-2 text-white transition-colors duration-300 ease-in-out focus:outline-none`}
+ >
+ Sign up with Email
+ </Button>
+ </form>
+ <p className="mt-4 w-full max-w-md px-4 text-xs text-muted-foreground sm:px-16">
+ By clicking continue, you acknowledge that you have read and agree
+ to Papermark&apos;s{" "}
+ <Link href="/terms" target="_blank" className="underline">
+ Terms of Service
+ </Link>{" "}
+ and{" "}
+ <Link href="/privacy" target="_blank" className="underline">
+ Privacy Policy
+ </Link>
+ .
+ </p>
+ </motion.div>
+ </motion.div>
+ </motion.div>
+ );
+}