Papermark is the open-source DocSend alternative and secure data rooms with built-in analytics and custom domains.
feat: Add internal name/alias field to Data Rooms
Cursor Agentaa3bcaa8897e
diff --git a/components/datarooms/add-dataroom-modal.tsx b/components/datarooms/add-dataroom-modal.tsxindex 664797db..45a78a03 100644--- a/components/datarooms/add-dataroom-modal.tsx+++ b/components/datarooms/add-dataroom-modal.tsx@@ -68,6 +68,7 @@ export function AddDataroomModal({}) {const router = useRouter();const [dataroomName, setDataroomName] = useState<string>("");+ const [dataroomInternalName, setDataroomInternalName] = useState<string>("");const [loading, setLoading] = useState<boolean>(false);const [open, setOpen] = useState<boolean>(openModal);const [activeTab, setActiveTab] = useState<string>("create");@@ -299,7 +300,10 @@ export function AddDataroomModal({type: dataroomType,// Name will be taken from template}- : { name: dataroomName.trim() };+ : {+ name: dataroomName.trim(),+ ...(dataroomInternalName.trim() && { internalName: dataroomInternalName.trim() }),+ };const response = await fetch(endpoint, {method: "POST",@@ -362,6 +366,7 @@ export function AddDataroomModal({if (!open) {setOpen(false);setDataroomName("");+ setDataroomInternalName("");setActiveTab("create");setDataroomType("");setAiDescription("");@@ -656,6 +661,24 @@ export function AddDataroomModal({value={dataroomName}onChange={(e) => setDataroomName(e.target.value)}/>+ <p className="text-xs text-muted-foreground">+ This name is visible to everyone viewing the dataroom.+ </p>+ </div>+ <div className="space-y-1">+ <Label htmlFor="dataroom-internal-name-create">+ Internal Name{" "}+ <span className="text-xs text-muted-foreground font-normal">(optional)</span>+ </Label>+ <Input+ id="dataroom-internal-name-create"+ placeholder="Friends & Family Round"+ value={dataroomInternalName}+ onChange={(e) => setDataroomInternalName(e.target.value)}+ />+ <p className="text-xs text-muted-foreground">+ A private name only visible to you. Useful for distinguishing multiple datarooms with the same public name.+ </p></div><Button type="submit" className="w-full" loading={loading}>Add new dataroomdiff --git a/components/datarooms/dataroom-card.tsx b/components/datarooms/dataroom-card.tsxindex f63f35b9..e164b6a6 100644--- a/components/datarooms/dataroom-card.tsx+++ b/components/datarooms/dataroom-card.tsx@@ -40,6 +40,7 @@ type DataroomTag = {type DataroomWithDetails = {id: string;name: string;+ internalName?: string | null;_count: {documents: number;views: number;@@ -87,7 +88,16 @@ export default function DataroomCard({ dataroom }: DataroomCardProps) {<Link href={`/datarooms/${dataroom.id}/documents`}><CardHeader><div className="flex items-start justify-between gap-2">- <CardTitle className="truncate text-lg">{dataroom.name}</CardTitle>+ <div className="flex-1 min-w-0">+ <CardTitle className="truncate text-lg">+ {dataroom.internalName || dataroom.name}+ </CardTitle>+ {dataroom.internalName && (+ <p className="truncate text-sm text-muted-foreground mt-0.5">+ {dataroom.name}+ </p>+ )}+ </div><div className="flex shrink-0 items-center gap-2"><TooltipProvider><Tooltip>diff --git a/components/datarooms/dataroom-header.tsx b/components/datarooms/dataroom-header.tsxindex 5e83182f..cb3029e8 100644--- a/components/datarooms/dataroom-header.tsx+++ b/components/datarooms/dataroom-header.tsx@@ -18,10 +18,12 @@ import {export const DataroomHeader = ({title,description,+ internalName,actions,}: {title: string;description: string;+ internalName?: string | null;actions?: React.ReactNode[];}) => {const [isLinkSheetOpen, setIsLinkSheetOpen] = useState<boolean>(false);@@ -39,9 +41,14 @@ export const DataroomHeader = ({<section className="mb-4"><div className="flex items-center justify-between"><div className="flex min-h-10 items-center gap-x-2 space-y-1">- <h1 className="text-xl font-semibold tracking-tight text-foreground sm:text-2xl">- {title}- </h1>+ <div>+ <h1 className="text-xl font-semibold tracking-tight text-foreground sm:text-2xl">+ {internalName || title}+ </h1>+ {internalName && (+ <p className="text-sm text-muted-foreground">{title}</p>+ )}+ </div>{dataroom?.enableChangeNotifications ? (<Tooltip><TooltipTrigger asChild>diff --git a/ee/features/conversations/pages/conversation-detail.tsx b/ee/features/conversations/pages/conversation-detail.tsxindex bd5c06bf..c79e6a61 100644--- a/ee/features/conversations/pages/conversation-detail.tsx+++ b/ee/features/conversations/pages/conversation-detail.tsx@@ -364,7 +364,7 @@ export default function ConversationDetailPage() {<AppLayout><div className="relative mx-2 my-4 space-y-8 overflow-hidden px-1 sm:mx-3 md:mx-5 md:mt-5 lg:mx-7 lg:mt-8 xl:mx-10"><header>- <DataroomHeader title={dataroom.name} description={dataroom.pId} />+ <DataroomHeader title={dataroom.name} description={dataroom.pId} internalName={dataroom.internalName} /><DataroomNavigation dataroomId={dataroom.id} /></header>diff --git a/ee/features/conversations/pages/conversation-overview.tsx b/ee/features/conversations/pages/conversation-overview.tsxindex 63650dc4..2e26b172 100644--- a/ee/features/conversations/pages/conversation-overview.tsx+++ b/ee/features/conversations/pages/conversation-overview.tsx@@ -203,7 +203,7 @@ export default function DataroomConversationsPage() {<AppLayout><div className="relative mx-2 my-4 space-y-8 overflow-hidden px-1 sm:mx-3 md:mx-5 md:mt-5 lg:mx-7 lg:mt-8 xl:mx-10"><header>- <DataroomHeader title={dataroom.name} description={dataroom.pId} />+ <DataroomHeader title={dataroom.name} description={dataroom.pId} internalName={dataroom.internalName} /><DataroomNavigation dataroomId={dataroom.id} /></header>diff --git a/ee/features/conversations/pages/faq-overview.tsx b/ee/features/conversations/pages/faq-overview.tsxindex 60ea78e7..54d5980e 100644--- a/ee/features/conversations/pages/faq-overview.tsx+++ b/ee/features/conversations/pages/faq-overview.tsx@@ -285,7 +285,7 @@ export default function FAQOverview() {<AppLayout><div className="relative mx-2 mb-10 mt-4 space-y-8 overflow-hidden px-1 sm:mx-3 md:mx-5 md:mt-5 lg:mx-7 lg:mt-8 xl:mx-10"><header>- <DataroomHeader title={dataroom.name} description={dataroom.pId} />+ <DataroomHeader title={dataroom.name} description={dataroom.pId} internalName={dataroom.internalName} /><DataroomNavigation dataroomId={dataroom.id} /></header>@@ -334,7 +334,7 @@ export default function FAQOverview() {<AppLayout><div className="relative mx-2 mb-10 mt-4 space-y-8 overflow-hidden px-1 sm:mx-3 md:mx-5 md:mt-5 lg:mx-7 lg:mt-8 xl:mx-10"><header>- <DataroomHeader title={dataroom.name} description={dataroom.pId} />+ <DataroomHeader title={dataroom.name} description={dataroom.pId} internalName={dataroom.internalName} /><DataroomNavigation dataroomId={dataroom.id} /></header>diff --git a/pages/api/teams/[teamId]/datarooms/[id]/index.ts b/pages/api/teams/[teamId]/datarooms/[id]/index.tsindex 652de6e4..ad30e543 100644--- a/pages/api/teams/[teamId]/datarooms/[id]/index.ts+++ b/pages/api/teams/[teamId]/datarooms/[id]/index.ts@@ -110,6 +110,7 @@ export default async function handle(const {name,+ internalName,enableChangeNotifications,defaultPermissionStrategy,allowBulkDownload,@@ -118,6 +119,7 @@ export default async function handle(agentsEnabled,} = req.body as {name?: string;+ internalName?: string | null;enableChangeNotifications?: boolean;defaultPermissionStrategy?: DefaultPermissionStrategy;allowBulkDownload?: boolean;@@ -154,6 +156,9 @@ export default async function handle(},data: {...(name && { name }),+ ...(internalName !== undefined && {+ internalName: internalName === null || internalName === "" ? null : internalName.trim()+ }),...(typeof enableChangeNotifications === "boolean" && {enableChangeNotifications,}),diff --git a/pages/api/teams/[teamId]/datarooms/index.ts b/pages/api/teams/[teamId]/datarooms/index.tsindex 09a73b7b..1a7d23c4 100644--- a/pages/api/teams/[teamId]/datarooms/index.ts+++ b/pages/api/teams/[teamId]/datarooms/index.ts@@ -58,12 +58,22 @@ export default async function handle(teamId: teamId,};- // Search filter+ // Search filter - search both name and internalNameif (search) {- whereClause.name = {- contains: search,- mode: "insensitive",- };+ whereClause.OR = [+ {+ name: {+ contains: search,+ mode: "insensitive",+ },+ },+ {+ internalName: {+ contains: search,+ mode: "insensitive",+ },+ },+ ];}// Tags filter@@ -171,7 +181,7 @@ export default async function handle(const userId = (session.user as CustomUser).id;const { teamId } = req.query as { teamId: string };- const { name } = req.body as { name: string };+ const { name, internalName } = req.body as { name: string; internalName?: string };try {// Check if the user is part of the team@@ -238,6 +248,7 @@ export default async function handle(name: name,teamId: teamId,pId: pId,+ ...(internalName && { internalName: internalName.trim() }),},});diff --git a/pages/datarooms/[id]/analytics/index.tsx b/pages/datarooms/[id]/analytics/index.tsxindex e8662522..44c4dcc5 100644--- a/pages/datarooms/[id]/analytics/index.tsx+++ b/pages/datarooms/[id]/analytics/index.tsx@@ -65,6 +65,7 @@ export default function DataroomAnalyticsPage() {<DataroomHeadertitle={dataroom.name}description={dataroom.pId}+ internalName={dataroom.internalName}actions={[]}/><DataroomNavigation dataroomId={dataroom.id} />diff --git a/pages/datarooms/[id]/branding/index.tsx b/pages/datarooms/[id]/branding/index.tsxindex 84a83fdd..e27da0aa 100644--- a/pages/datarooms/[id]/branding/index.tsx+++ b/pages/datarooms/[id]/branding/index.tsx@@ -271,6 +271,7 @@ export default function DataroomBrandPage() {<DataroomHeadertitle={dataroom.name}description={dataroom.pId}+ internalName={dataroom.internalName}actions={[]}/>diff --git a/pages/datarooms/[id]/documents/[...name].tsx b/pages/datarooms/[id]/documents/[...name].tsxindex ad0a0915..a7c7df2b 100644--- a/pages/datarooms/[id]/documents/[...name].tsx+++ b/pages/datarooms/[id]/documents/[...name].tsx@@ -43,6 +43,7 @@ export default function Documents() {<DataroomHeadertitle={dataroom?.name ?? ""}description={dataroom?.pId ?? ""}+ internalName={dataroom?.internalName}actions={[]}/>diff --git a/pages/datarooms/[id]/documents/index.tsx b/pages/datarooms/[id]/documents/index.tsxindex eea37cb9..11ba7237 100644--- a/pages/datarooms/[id]/documents/index.tsx+++ b/pages/datarooms/[id]/documents/index.tsx@@ -37,6 +37,7 @@ export default function Documents() {<DataroomHeadertitle={dataroom?.name ?? ""}description={dataroom?.pId ?? ""}+ internalName={dataroom?.internalName}actions={[]}/>diff --git a/pages/datarooms/[id]/groups/[groupId]/group-analytics.tsx b/pages/datarooms/[id]/groups/[groupId]/group-analytics.tsxindex 9a6bdf0d..b85d911a 100644--- a/pages/datarooms/[id]/groups/[groupId]/group-analytics.tsx+++ b/pages/datarooms/[id]/groups/[groupId]/group-analytics.tsx@@ -23,6 +23,7 @@ export default function DataroomGroupPage() {<DataroomHeadertitle={dataroom.name}description={dataroom.pId}+ internalName={dataroom.internalName}actions={[]}/>diff --git a/pages/datarooms/[id]/groups/[groupId]/index.tsx b/pages/datarooms/[id]/groups/[groupId]/index.tsxindex 31f2a66d..97b313f6 100644--- a/pages/datarooms/[id]/groups/[groupId]/index.tsx+++ b/pages/datarooms/[id]/groups/[groupId]/index.tsx@@ -30,6 +30,7 @@ export default function DataroomGroupPage() {<DataroomHeadertitle={dataroom.name}description={dataroom.pId}+ internalName={dataroom.internalName}actions={[]}/>diff --git a/pages/datarooms/[id]/groups/[groupId]/links.tsx b/pages/datarooms/[id]/groups/[groupId]/links.tsxindex 1925ec3b..576d630a 100644--- a/pages/datarooms/[id]/groups/[groupId]/links.tsx+++ b/pages/datarooms/[id]/groups/[groupId]/links.tsx@@ -27,6 +27,7 @@ export default function DataroomGroupLinksPage() {<DataroomHeadertitle={dataroom.name}description={dataroom.pId}+ internalName={dataroom.internalName}actions={[]}/>diff --git a/pages/datarooms/[id]/groups/[groupId]/members.tsx b/pages/datarooms/[id]/groups/[groupId]/members.tsxindex 6f56b3ae..ec7033d4 100644--- a/pages/datarooms/[id]/groups/[groupId]/members.tsx+++ b/pages/datarooms/[id]/groups/[groupId]/members.tsx@@ -23,6 +23,7 @@ export default function DataroomGroupPage() {<DataroomHeadertitle={dataroom.name}description={dataroom.pId}+ internalName={dataroom.internalName}actions={[]}/>diff --git a/pages/datarooms/[id]/groups/[groupId]/permissions.tsx b/pages/datarooms/[id]/groups/[groupId]/permissions.tsxindex c5e52cd3..cce95097 100644--- a/pages/datarooms/[id]/groups/[groupId]/permissions.tsx+++ b/pages/datarooms/[id]/groups/[groupId]/permissions.tsx@@ -23,6 +23,7 @@ export default function DataroomGroupPage() {<DataroomHeadertitle={dataroom.name}description={dataroom.pId}+ internalName={dataroom.internalName}actions={[]}/>diff --git a/pages/datarooms/[id]/groups/index.tsx b/pages/datarooms/[id]/groups/index.tsxindex ecc78a25..0ba4afcb 100644--- a/pages/datarooms/[id]/groups/index.tsx+++ b/pages/datarooms/[id]/groups/index.tsx@@ -53,6 +53,7 @@ export default function DataroomGroupPage() {<DataroomHeadertitle={dataroom.name}description={dataroom.pId}+ internalName={dataroom.internalName}actions={[]}/>diff --git a/pages/datarooms/[id]/index.tsx b/pages/datarooms/[id]/index.tsxindex fb670b70..474a5150 100644--- a/pages/datarooms/[id]/index.tsx+++ b/pages/datarooms/[id]/index.tsx@@ -28,6 +28,7 @@ export default function DataroomPage() {<DataroomHeadertitle={dataroom.name}description={dataroom.pId}+ internalName={dataroom.internalName}actions={[<Button onClick={() => setIsLinkSheetOpen(true)} key={1}>Sharediff --git a/pages/datarooms/[id]/permissions/index.tsx b/pages/datarooms/[id]/permissions/index.tsxindex c88f3155..f2d05e26 100644--- a/pages/datarooms/[id]/permissions/index.tsx+++ b/pages/datarooms/[id]/permissions/index.tsx@@ -32,6 +32,7 @@ export default function DataroomAnalyticsPage() {<DataroomHeadertitle={dataroom.name}description={dataroom.pId}+ internalName={dataroom.internalName}actions={[<Button onClick={() => setIsLinkSheetOpen(true)} key={1}>Sharediff --git a/pages/datarooms/[id]/settings/downloads.tsx b/pages/datarooms/[id]/settings/downloads.tsxindex 47c5eb57..8c5faf7d 100644--- a/pages/datarooms/[id]/settings/downloads.tsx+++ b/pages/datarooms/[id]/settings/downloads.tsx@@ -20,6 +20,7 @@ export default function Downloads() {<DataroomHeadertitle={dataroom.name}description={dataroom.pId}+ internalName={dataroom.internalName}actions={[]}/>diff --git a/pages/datarooms/[id]/settings/file-permissions.tsx b/pages/datarooms/[id]/settings/file-permissions.tsxindex 6fced07a..89fe659f 100644--- a/pages/datarooms/[id]/settings/file-permissions.tsx+++ b/pages/datarooms/[id]/settings/file-permissions.tsx@@ -20,6 +20,7 @@ export default function PermissionsSettings() {<DataroomHeadertitle={dataroom.name}description={dataroom.pId}+ internalName={dataroom.internalName}actions={[]}/>diff --git a/pages/datarooms/[id]/settings/index.tsx b/pages/datarooms/[id]/settings/index.tsxindex 1556f473..0347b895 100644--- a/pages/datarooms/[id]/settings/index.tsx+++ b/pages/datarooms/[id]/settings/index.tsx@@ -47,6 +47,7 @@ export default function Settings() {<DataroomHeadertitle={dataroom.name}description={dataroom.pId}+ internalName={dataroom.internalName}actions={[]}/>@@ -62,7 +63,7 @@ export default function Settings() {<div className="grid gap-6"><Formtitle="Dataroom Name"- description="This is the name of your data room on Papermark."+ description="This is the public name of your data room visible to all viewers."inputAttrs={{name: "name",placeholder: "My Dataroom",@@ -91,6 +92,39 @@ export default function Settings() {})}/>+ <Form+ title="Internal Name"+ description="A private name only visible to you. Useful for distinguishing multiple data rooms with the same public name."+ inputAttrs={{+ name: "internalName",+ placeholder: "Friends & Family Round",+ maxLength: 156,+ }}+ defaultValue={dataroom.internalName ?? ""}+ helpText="Max 156 characters. Leave empty to remove."+ handleSubmit={(updateData) =>+ fetch(`/api/teams/${teamId}/datarooms/${dataroom.id}`, {+ method: "PATCH",+ headers: {+ "Content-Type": "application/json",+ },+ body: JSON.stringify({+ internalName: updateData.internalName || null,+ }),+ }).then(async (res) => {+ if (res.status === 200) {+ await Promise.all([+ mutate(`/api/teams/${teamId}/datarooms`),+ mutate(`/api/teams/${teamId}/datarooms/${dataroom.id}`),+ ]);+ toast.success("Successfully updated internal name!");+ } else {+ const { error } = await res.json();+ toast.error(error.message);+ }+ })+ }+ /><Formtitle="Show Last Updated"description="Display the last updated date on your dataroom banner."diff --git a/pages/datarooms/[id]/settings/notifications.tsx b/pages/datarooms/[id]/settings/notifications.tsxindex cd2e79d6..e4c897ab 100644--- a/pages/datarooms/[id]/settings/notifications.tsx+++ b/pages/datarooms/[id]/settings/notifications.tsx@@ -20,6 +20,7 @@ export default function Notifications() {<DataroomHeadertitle={dataroom.name}description={dataroom.pId}+ internalName={dataroom.internalName}actions={[]}/>diff --git a/pages/datarooms/[id]/users/index.tsx b/pages/datarooms/[id]/users/index.tsxindex 5b9c0aa8..59b58aac 100644--- a/pages/datarooms/[id]/users/index.tsx+++ b/pages/datarooms/[id]/users/index.tsx@@ -16,7 +16,7 @@ export default function DataroomUsersPage() {<AppLayout><div className="relative mx-2 mb-10 mt-4 space-y-8 overflow-hidden px-1 sm:mx-3 md:mx-5 md:mt-5 lg:mx-7 lg:mt-8 xl:mx-10"><header>- <DataroomHeader title={dataroom.name} description={dataroom.pId} />+ <DataroomHeader title={dataroom.name} description={dataroom.pId} internalName={dataroom.internalName} /><DataroomNavigation dataroomId={dataroom.id} /></header>diff --git a/prisma/migrations/20260113000000_add_internal_name_to_dataroom/migration.sql b/prisma/migrations/20260113000000_add_internal_name_to_dataroom/migration.sqlnew file mode 100644index 00000000..615549f9--- /dev/null+++ b/prisma/migrations/20260113000000_add_internal_name_to_dataroom/migration.sql@@ -0,0 +1,2 @@+-- AlterTable+ALTER TABLE "Dataroom" ADD COLUMN "internalName" TEXT;diff --git a/prisma/schema/dataroom.prisma b/prisma/schema/dataroom.prismaindex b03b5652..da3c71cf 100644--- a/prisma/schema/dataroom.prisma+++ b/prisma/schema/dataroom.prisma@@ -2,6 +2,7 @@ model Dataroom {id String @id @default(cuid())pId String @unique // This is the generated public ID for the dataroom dr_1234name String+ internalName String? // Private, internal name/alias visible only to the dataroom ownerdescription String?teamId Stringteam Team @relation(fields: [teamId], references: [id], onDelete: Cascade)