Skip to content

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

feat: add option to remove visitor stats and papermark branding

Marc Seitz2fe21565da01
diff --git a/components/links/link-sheet/index.tsx b/components/links/link-sheet/index.tsx
index afa7b26f..d27a9fd6 100644
--- a/components/links/link-sheet/index.tsx
+++ b/components/links/link-sheet/index.tsx
@@ -3,6 +3,7 @@ import { useRouter } from "next/router";
import { Dispatch, SetStateAction, useEffect, useState } from "react";
import { useTeam } from "@/context/team-context";
+import { LinkType } from "@prisma/client";
import { toast } from "sonner";
import { mutate } from "swr";
@@ -14,7 +15,6 @@ import { Separator } from "@/components/ui/separator";
import {
Sheet,
SheetContent,
- SheetDescription,
SheetFooter,
SheetHeader,
SheetTitle,
@@ -22,7 +22,6 @@ import {
import { useAnalytics } from "@/lib/analytics";
import { usePlan } from "@/lib/swr/use-billing";
-import { useDocumentLinks } from "@/lib/swr/use-document";
import { useDomains } from "@/lib/swr/use-domains";
import { LinkWithViews } from "@/lib/types";
import { convertDataUrlToFile, uploadImage } from "@/lib/utils";
@@ -30,7 +29,7 @@ import { convertDataUrlToFile, uploadImage } from "@/lib/utils";
import DomainSection from "./domain-section";
import { LinkOptions } from "./link-options";
-export const DEFAULT_LINK_PROPS = {
+export const DEFAULT_LINK_PROPS = (linkType: LinkType) => ({
id: null,
name: null,
domain: null,
@@ -43,7 +42,7 @@ export const DEFAULT_LINK_PROPS = {
allowList: [],
denyList: [],
enableNotification: true,
- enableFeedback: true,
+ enableFeedback: false,
enableScreenshotProtection: false,
enableCustomMetatag: false,
metaTitle: null,
@@ -54,7 +53,8 @@ export const DEFAULT_LINK_PROPS = {
questionType: null,
enableAgreement: false,
agreementId: null,
-};
+ showBanner: linkType === LinkType.DOCUMENT_LINK ? true : false,
+});
export type DEFAULT_LINK_TYPE = {
id: string | null;
@@ -80,6 +80,7 @@ export type DEFAULT_LINK_TYPE = {
questionType: string | null;
enableAgreement: boolean; // agreement
agreementId: string | null;
+ showBanner: boolean;
};
export default function LinkSheet({
@@ -91,7 +92,7 @@ export default function LinkSheet({
}: {
isOpen: boolean;
setIsOpen: Dispatch<SetStateAction<boolean>>;
- linkType: "DOCUMENT_LINK" | "DATAROOM_LINK";
+ linkType: LinkType;
currentLink?: DEFAULT_LINK_TYPE;
existingLinks?: LinkWithViews[];
}) {
@@ -99,14 +100,16 @@ export default function LinkSheet({
const teamInfo = useTeam();
const { plan } = usePlan();
const analytics = useAnalytics();
- const [data, setData] = useState<DEFAULT_LINK_TYPE>(DEFAULT_LINK_PROPS);
+ const [data, setData] = useState<DEFAULT_LINK_TYPE>(
+ DEFAULT_LINK_PROPS(linkType),
+ );
const [isLoading, setIsLoading] = useState<boolean>(false);
const router = useRouter();
const targetId = router.query.id as string;
useEffect(() => {
- setData(currentLink || DEFAULT_LINK_PROPS);
+ setData(currentLink || DEFAULT_LINK_PROPS(linkType));
}, [currentLink]);
const handleSubmit = async (event: any) => {
@@ -195,7 +198,7 @@ export default function LinkSheet({
toast.success("Link created successfully");
}
- setData(DEFAULT_LINK_PROPS);
+ setData(DEFAULT_LINK_PROPS(linkType));
setIsLoading(false);
};
@@ -248,7 +251,11 @@ export default function LinkSheet({
</div>
</div>
- <LinkOptions data={data} setData={setData} />
+ <LinkOptions
+ data={data}
+ setData={setData}
+ linkType={linkType}
+ />
</div>
</div>
</div>
diff --git a/components/links/link-sheet/link-item.tsx b/components/links/link-sheet/link-item.tsx
index cbe617c6..7e1d6f4f 100644
--- a/components/links/link-sheet/link-item.tsx
+++ b/components/links/link-sheet/link-item.tsx
@@ -3,8 +3,6 @@ import { Switch } from "@/components/ui/switch";
import { cn } from "@/lib/utils";
-import { LinkUpgradeOptions } from "./link-options";
-
export default function LinkItem({
title,
enabled,
diff --git a/components/links/link-sheet/link-options.tsx b/components/links/link-sheet/link-options.tsx
index ed16e85a..7f306af5 100644
--- a/components/links/link-sheet/link-options.tsx
+++ b/components/links/link-sheet/link-options.tsx
@@ -1,5 +1,7 @@
import { useState } from "react";
+import { LinkType } from "@prisma/client";
+
import { UpgradePlanModal } from "@/components/billing/upgrade-plan-modal";
import { DEFAULT_LINK_TYPE } from "@/components/links/link-sheet";
import AllowDownloadSection from "@/components/links/link-sheet/allow-download-section";
@@ -12,12 +14,7 @@ import ExpirationSection from "@/components/links/link-sheet/expiration-section"
import FeedbackSection from "@/components/links/link-sheet/feedback-section";
import OGSection from "@/components/links/link-sheet/og-section";
import PasswordSection from "@/components/links/link-sheet/password-section";
-import {
- Accordion,
- AccordionContent,
- AccordionItem,
- AccordionTrigger,
-} from "@/components/ui/accordion";
+import { ProBannerSection } from "@/components/links/link-sheet/pro-banner-section";
import { usePlan } from "@/lib/swr/use-billing";
import useLimits from "@/lib/swr/use-limits";
@@ -35,9 +32,11 @@ export type LinkUpgradeOptions = {
export const LinkOptions = ({
data,
setData,
+ linkType,
}: {
data: DEFAULT_LINK_TYPE;
setData: React.Dispatch<React.SetStateAction<DEFAULT_LINK_TYPE>>;
+ linkType: LinkType;
}) => {
const { plan } = usePlan();
const { limits } = useLimits();
@@ -117,7 +116,13 @@ export const LinkOptions = ({
hasFreePlan={isNotDatarooms}
handleUpgradeStateChange={handleUpgradeStateChange}
/>
-
+ {linkType === LinkType.DOCUMENT_LINK ? (
+ <ProBannerSection
+ {...{ data, setData }}
+ hasFreePlan={hasFreePlan || plan === "starter"}
+ handleUpgradeStateChange={handleUpgradeStateChange}
+ />
+ ) : null}
<UpgradePlanModal
clickedPlan={upgradePlan}
open={openUpgradeModal}
diff --git a/components/links/link-sheet/pro-banner-section.tsx b/components/links/link-sheet/pro-banner-section.tsx
new file mode 100644
index 00000000..18e4b96f
--- /dev/null
+++ b/components/links/link-sheet/pro-banner-section.tsx
@@ -0,0 +1,54 @@
+import { useEffect, useState } from "react";
+
+import { DEFAULT_LINK_TYPE } from ".";
+import LinkItem from "./link-item";
+import { LinkUpgradeOptions } from "./link-options";
+
+export function ProBannerSection({
+ data,
+ setData,
+ hasFreePlan,
+ handleUpgradeStateChange,
+}: {
+ data: DEFAULT_LINK_TYPE;
+ setData: React.Dispatch<React.SetStateAction<DEFAULT_LINK_TYPE>>;
+ hasFreePlan: boolean;
+ handleUpgradeStateChange: ({
+ state,
+ trigger,
+ plan,
+ }: LinkUpgradeOptions) => void;
+}) {
+ const { showBanner } = data;
+ const [enabled, setEnabled] = useState<boolean>(showBanner);
+
+ useEffect(() => {
+ setEnabled(showBanner);
+ }, [showBanner]);
+
+ const handleShowBanner = () => {
+ const updatedShowBanner = !enabled;
+ console.log("updatedShowBanner", updatedShowBanner);
+ setData({ ...data, showBanner: updatedShowBanner });
+ setEnabled(updatedShowBanner);
+ };
+
+ return (
+ <div className="pb-5">
+ <LinkItem
+ title="Show Visitor Statistics & Papermark Branding"
+ enabled={enabled}
+ action={handleShowBanner}
+ hasFreePlan={hasFreePlan}
+ requiredPlan="pro"
+ upgradeAction={() =>
+ handleUpgradeStateChange({
+ state: true,
+ trigger: "link_sheet_hide_pro_banner_section",
+ plan: "Pro",
+ })
+ }
+ />
+ </div>
+ );
+}
diff --git a/components/links/links-table.tsx b/components/links/links-table.tsx
index 2a1b6903..d77989d3 100644
--- a/components/links/links-table.tsx
+++ b/components/links/links-table.tsx
@@ -62,8 +62,9 @@ export default function LinksTable({
const [isLoading, setIsLoading] = useState<boolean>(false);
const [isLinkSheetVisible, setIsLinkSheetVisible] = useState<boolean>(false);
- const [selectedLink, setSelectedLink] =
- useState<DEFAULT_LINK_TYPE>(DEFAULT_LINK_PROPS);
+ const [selectedLink, setSelectedLink] = useState<DEFAULT_LINK_TYPE>(
+ DEFAULT_LINK_PROPS(`${targetType}_LINK`),
+ );
const handleCopyToClipboard = (linkString: string) => {
copyToClipboard(`${linkString}`, "Link copied to clipboard.");
@@ -100,6 +101,7 @@ export default function LinksTable({
metaImage: link.metaImage,
enableAgreement: link.enableAgreement ? link.enableAgreement : false,
agreementId: link.agreementId,
+ showBanner: link.showBanner ?? false,
});
//wait for dropdown to close before opening the link sheet
setTimeout(() => {
diff --git a/components/welcome/notion-form.tsx b/components/welcome/notion-form.tsx
index 6db7e35c..25eb652f 100644
--- a/components/welcome/notion-form.tsx
+++ b/components/welcome/notion-form.tsx
@@ -3,6 +3,7 @@ import { useRouter } from "next/router";
import { type FormEvent, use, useState } from "react";
import { useTeam } from "@/context/team-context";
+import { LinkType } from "@prisma/client";
import { motion } from "framer-motion";
import { usePlausible } from "next-plausible";
import { parsePageId } from "notion-utils";
@@ -41,8 +42,9 @@ export default function NotionForm() {
const [currentLinkId, setCurrentLinkId] = useState<string | null>(null);
const [currentDocId, setCurrentDocId] = useState<string | null>(null);
const [notionLink, setNotionLink] = useState<string | null>(null);
- const [linkData, setLinkData] =
- useState<DEFAULT_LINK_TYPE>(DEFAULT_LINK_PROPS);
+ const [linkData, setLinkData] = useState<DEFAULT_LINK_TYPE>(
+ DEFAULT_LINK_PROPS(LinkType.DOCUMENT_LINK),
+ );
const teamInfo = useTeam();
const createNotionFileName = () => {
@@ -325,7 +327,11 @@ export default function NotionForm() {
</span>
</AccordionTrigger>
<AccordionContent className="first:pt-5">
- <LinkOptions data={linkData} setData={setLinkData} />
+ <LinkOptions
+ data={linkData}
+ setData={setLinkData}
+ linkType={LinkType.DOCUMENT_LINK}
+ />
</AccordionContent>
</AccordionItem>
</Accordion>
diff --git a/components/welcome/special-upload.tsx b/components/welcome/special-upload.tsx
index 7748946c..24fc2d89 100644
--- a/components/welcome/special-upload.tsx
+++ b/components/welcome/special-upload.tsx
@@ -3,6 +3,7 @@ import { useRouter } from "next/router";
import { useEffect, useState } from "react";
import { useTeam } from "@/context/team-context";
+import { LinkType } from "@prisma/client";
import { motion } from "framer-motion";
import Cookies from "js-cookie";
import { usePlausible } from "next-plausible";
@@ -42,8 +43,9 @@ export default function DeckGeneratorUpload() {
const [currentBlob, setCurrentBlob] = useState<boolean>(false);
const [currentLinkId, setCurrentLinkId] = useState<string | null>(null);
const [currentDocId, setCurrentDocId] = useState<string | null>(null);
- const [linkData, setLinkData] =
- useState<DEFAULT_LINK_TYPE>(DEFAULT_LINK_PROPS);
+ const [linkData, setLinkData] = useState<DEFAULT_LINK_TYPE>(
+ DEFAULT_LINK_PROPS(LinkType.DOCUMENT_LINK),
+ );
const teamInfo = useTeam();
const teamId = teamInfo?.currentTeam?.id as string;
@@ -334,7 +336,11 @@ export default function DeckGeneratorUpload() {
</span>
</AccordionTrigger>
<AccordionContent className="first:pt-5">
- <LinkOptions data={linkData} setData={setLinkData} />
+ <LinkOptions
+ data={linkData}
+ setData={setLinkData}
+ linkType={LinkType.DOCUMENT_LINK}
+ />
</AccordionContent>
</AccordionItem>
</Accordion>
diff --git a/components/welcome/upload.tsx b/components/welcome/upload.tsx
index cdaff8c7..93981ce6 100644
--- a/components/welcome/upload.tsx
+++ b/components/welcome/upload.tsx
@@ -3,6 +3,7 @@ import { useRouter } from "next/router";
import { useState } from "react";
import { useTeam } from "@/context/team-context";
+import { LinkType } from "@prisma/client";
import { motion } from "framer-motion";
import { usePlausible } from "next-plausible";
import { toast } from "sonner";
@@ -41,8 +42,9 @@ export default function Upload() {
const [currentBlob, setCurrentBlob] = useState<boolean>(false);
const [currentLinkId, setCurrentLinkId] = useState<string | null>(null);
const [currentDocId, setCurrentDocId] = useState<string | null>(null);
- const [linkData, setLinkData] =
- useState<DEFAULT_LINK_TYPE>(DEFAULT_LINK_PROPS);
+ const [linkData, setLinkData] = useState<DEFAULT_LINK_TYPE>(
+ DEFAULT_LINK_PROPS(LinkType.DOCUMENT_LINK),
+ );
const teamInfo = useTeam();
const teamId = teamInfo?.currentTeam?.id as string;
@@ -314,7 +316,11 @@ export default function Upload() {
</span>
</AccordionTrigger>
<AccordionContent className="first:pt-5">
- <LinkOptions data={linkData} setData={setLinkData} />
+ <LinkOptions
+ data={linkData}
+ setData={setLinkData}
+ linkType={LinkType.DOCUMENT_LINK}
+ />
</AccordionContent>
</AccordionItem>
</Accordion>
diff --git a/pages/api/links/[id]/index.ts b/pages/api/links/[id]/index.ts
index 41bc8d23..3cbd532f 100644
--- a/pages/api/links/[id]/index.ts
+++ b/pages/api/links/[id]/index.ts
@@ -52,6 +52,7 @@ export default async function handle(
},
enableAgreement: true,
agreement: true,
+ showBanner: true,
},
});
@@ -327,6 +328,7 @@ export default async function handle(
},
enableAgreement: linkData.enableAgreement,
agreementId: linkData.agreementId || null,
+ showBanner: linkData.showBanner,
},
include: {
views: {
diff --git a/pages/api/links/domains/[...domainSlug].ts b/pages/api/links/domains/[...domainSlug].ts
index d8d103f6..4d29213b 100644
--- a/pages/api/links/domains/[...domainSlug].ts
+++ b/pages/api/links/domains/[...domainSlug].ts
@@ -62,6 +62,7 @@ export default async function handle(
},
enableAgreement: true,
agreement: true,
+ showBanner: true,
document: {
select: {
team: {
diff --git a/pages/api/links/index.ts b/pages/api/links/index.ts
index 2127aa5c..1d86c9d6 100644
--- a/pages/api/links/index.ts
+++ b/pages/api/links/index.ts
@@ -160,6 +160,7 @@ export default async function handler(
enableAgreement: linkData.enableAgreement,
agreementId: linkData.agreementId,
}),
+ showBanner: linkData.showBanner,
},
});
diff --git a/pages/view/[linkId]/index.tsx b/pages/view/[linkId]/index.tsx
index 1f6038b7..900f2c92 100644
--- a/pages/view/[linkId]/index.tsx
+++ b/pages/view/[linkId]/index.tsx
@@ -92,11 +92,8 @@ export const getStaticProps = async (context: GetStaticPropsContext) => {
metaImage: link.metaImage,
metaUrl: `https://www.papermark.io/view/${linkId}`,
},
- showPoweredByBanner: teamPlan === "free",
- showAccountCreationSlide:
- teamPlan === "free" ||
- teamPlan === "pro" ||
- teamPlan.includes("drtrial"),
+ showPoweredByBanner: link.showBanner || teamPlan === "free",
+ showAccountCreationSlide: link.showBanner || teamPlan === "free",
useAdvancedExcelViewer:
teamId === "clwt1qwt00000qz39aqra71w6" ||
teamId === "clup33by90000oewh4rfvp2eg",
diff --git a/pages/view/domains/[domain]/[slug]/index.tsx b/pages/view/domains/[domain]/[slug]/index.tsx
index cd339a31..144b87b5 100644
--- a/pages/view/domains/[domain]/[slug]/index.tsx
+++ b/pages/view/domains/[domain]/[slug]/index.tsx
@@ -97,8 +97,7 @@ export const getStaticProps = async (context: GetStaticPropsContext) => {
metaImage: link.metaImage,
metaUrl: `https://${domain}/${slug}` || null,
},
- showPoweredByBanner: teamPlan === "free",
- showAccountCreationSlide: teamPlan === "free" || teamPlan === "pro",
+ showAccountCreationSlide: link.showBanner || teamPlan === "free",
useAdvancedExcelViewer:
teamId === "clwt1qwt00000qz39aqra71w6" ||
teamId === "clup33by90000oewh4rfvp2eg",
diff --git a/prisma/migrations/20240731000000_add_link_show_banner/migration.sql b/prisma/migrations/20240731000000_add_link_show_banner/migration.sql
new file mode 100644
index 00000000..ed2b85b5
--- /dev/null
+++ b/prisma/migrations/20240731000000_add_link_show_banner/migration.sql
@@ -0,0 +1,3 @@
+-- AlterTable
+ALTER TABLE "Link" ADD COLUMN "showBanner" BOOLEAN DEFAULT false;
+
diff --git a/prisma/schema.prisma b/prisma/schema.prisma
index 30b7663b..4648623f 100644
--- a/prisma/schema.prisma
+++ b/prisma/schema.prisma
@@ -230,6 +230,7 @@ model Link {
enableAgreement Boolean? @default(false) // Optional give user a option to enable the terms and conditions
agreement Agreement? @relation(fields: [agreementId], references: [id], onDelete: SetNull)
agreementId String? // This can be nullable, representing links without agreements
+ showBanner Boolean? @default(false) // Optional give user a option to show the banner and end of document signup form
// custom metatags
metaTitle String? // This will be the meta title of the link