Skip to content

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

feat: apply group permissions on attach

Marc Seitz18042fa8b081
diff --git a/lib/api/links/revalidate.ts b/lib/api/links/revalidate.ts
index fbae42ed..4298603e 100644
--- a/lib/api/links/revalidate.ts
+++ b/lib/api/links/revalidate.ts
@@ -1,5 +1,73 @@
import prisma from "@/lib/prisma";
+type LinkForRevalidation = {
+ id: string;
+ domainId: string | null;
+};
+
+type RevalidateConfig = {
+ revalidateUrl: string;
+ revalidateToken: string;
+};
+
+const REVALIDATE_CONCURRENCY = 10;
+const REVALIDATE_TIMEOUT_MS = 10_000;
+
+function getRevalidateConfig(): RevalidateConfig | null {
+ const revalidateUrl = process.env.NEXTAUTH_URL;
+ const revalidateToken = process.env.REVALIDATE_TOKEN;
+
+ if (!revalidateUrl || !revalidateToken) return null;
+
+ return { revalidateUrl, revalidateToken };
+}
+
+async function revalidateSingleLink(
+ link: LinkForRevalidation,
+ config: RevalidateConfig,
+): Promise<void> {
+ const controller = new AbortController();
+ const timeout = setTimeout(
+ () => controller.abort(),
+ REVALIDATE_TIMEOUT_MS,
+ );
+
+ try {
+ const response = await fetch(
+ `${config.revalidateUrl}/api/revalidate?secret=${config.revalidateToken}&linkId=${link.id}&hasDomain=${link.domainId ? "true" : "false"}`,
+ { signal: controller.signal },
+ );
+
+ if (!response.ok) {
+ console.error(
+ `Error revalidating link ${link.id}: unexpected status ${response.status}`,
+ );
+ }
+ } catch (error) {
+ console.error(`Error revalidating link ${link.id}:`, error);
+ } finally {
+ clearTimeout(timeout);
+ }
+}
+
+async function revalidateLinks(links: LinkForRevalidation[]): Promise<void> {
+ if (links.length === 0) return;
+
+ const config = getRevalidateConfig();
+ if (!config) return;
+
+ let cursor = 0;
+ const worker = async (): Promise<void> => {
+ while (cursor < links.length) {
+ const link = links[cursor++];
+ await revalidateSingleLink(link, config);
+ }
+ };
+
+ const workerCount = Math.min(REVALIDATE_CONCURRENCY, links.length);
+ await Promise.all(Array.from({ length: workerCount }, () => worker()));
+}
+
/**
* Trigger ISR revalidation for a single link by ID.
*/
@@ -12,13 +80,7 @@ export async function revalidateLinkById(linkId: string): Promise<void> {
if (!link) return;
- const revalidateUrl = process.env.NEXTAUTH_URL;
- const revalidateToken = process.env.REVALIDATE_TOKEN;
- if (!revalidateUrl || !revalidateToken) return;
-
- await fetch(
- `${revalidateUrl}/api/revalidate?secret=${revalidateToken}&linkId=${link.id}&hasDomain=${link.domainId ? "true" : "false"}`,
- );
+ await revalidateLinks([link]);
} catch (error) {
console.error(`Error revalidating link ${linkId}:`, error);
}
@@ -43,24 +105,38 @@ export async function revalidateLinksForPermissionGroup(
},
});
- if (links.length === 0) return;
+ await revalidateLinks(links);
+ } catch (error) {
+ console.error(
+ `Error revalidating links for permission group ${permissionGroupId}:`,
+ error,
+ );
+ }
+}
- const revalidateUrl = process.env.NEXTAUTH_URL;
- const revalidateToken = process.env.REVALIDATE_TOKEN;
- if (!revalidateUrl || !revalidateToken) return;
+/**
+ * Trigger ISR revalidation for all non-deleted restricted links in a dataroom.
+ */
+export async function revalidateLinksForDataroom(
+ dataroomId: string,
+): Promise<void> {
+ try {
+ const links = await prisma.link.findMany({
+ where: {
+ dataroomId,
+ deletedAt: null,
+ OR: [{ permissionGroupId: { not: null } }, { groupId: { not: null } }],
+ },
+ select: {
+ id: true,
+ domainId: true,
+ },
+ });
- await Promise.all(
- links.map((link) =>
- fetch(
- `${revalidateUrl}/api/revalidate?secret=${revalidateToken}&linkId=${link.id}&hasDomain=${link.domainId ? "true" : "false"}`,
- ).catch((error) => {
- console.error(`Error revalidating link ${link.id}:`, error);
- }),
- ),
- );
+ await revalidateLinks(links);
} catch (error) {
console.error(
- `Error revalidating links for permission group ${permissionGroupId}:`,
+ `Error revalidating links for dataroom ${dataroomId}:`,
error,
);
}
diff --git a/pages/api/teams/[teamId]/datarooms/[id]/apply-permissions.ts b/pages/api/teams/[teamId]/datarooms/[id]/apply-permissions.ts
index cf568947..a5d6dbe5 100644
--- a/pages/api/teams/[teamId]/datarooms/[id]/apply-permissions.ts
+++ b/pages/api/teams/[teamId]/datarooms/[id]/apply-permissions.ts
@@ -1,24 +1,19 @@
import { NextApiRequest, NextApiResponse } from "next";
import { authOptions } from "@/pages/api/auth/[...nextauth]";
-import {
- DefaultPermissionStrategy,
- ItemType,
- RootItemAccess,
-} from "@prisma/client";
+import { DefaultPermissionStrategy } from "@prisma/client";
+import { waitUntil } from "@vercel/functions";
import { getServerSession } from "next-auth";
-import { resolveRootItemAccessFlags } from "@/lib/dataroom/root-item-access";
+import { revalidateLinksForDataroom } from "@/lib/api/links/revalidate";
+import { applyDataroomDocumentPermissionDefaults } from "@/lib/dataroom/apply-default-permissions";
import { errorhandler } from "@/lib/errorHandler";
import prisma from "@/lib/prisma";
import { CustomUser } from "@/lib/types";
-type GroupTarget = "VIEWER_GROUP" | "PERMISSION_GROUP";
-
-type DataroomDocumentRef = {
- id: string;
- documentId: string;
- folderId: string | null;
+export const config = {
+ // in order to enable `waitUntil` function
+ supportsResponseStreaming: true,
};
const VALID_STRATEGIES = new Set<string>([
@@ -27,40 +22,6 @@ const VALID_STRATEGIES = new Set<string>([
"HIDDEN_BY_DEFAULT",
]);
-async function revalidateLinksForDataroom(dataroomId: string): Promise<void> {
- try {
- const links = await prisma.link.findMany({
- where: {
- dataroomId,
- deletedAt: null,
- OR: [{ permissionGroupId: { not: null } }, { groupId: { not: null } }],
- },
- select: { id: true, domainId: true },
- });
-
- if (links.length === 0) return;
-
- const revalidateUrl = process.env.NEXTAUTH_URL;
- const revalidateToken = process.env.REVALIDATE_TOKEN;
- if (!revalidateUrl || !revalidateToken) return;
-
- await Promise.all(
- links.map((link) =>
- fetch(
- `${revalidateUrl}/api/revalidate?secret=${revalidateToken}&linkId=${link.id}&hasDomain=${link.domainId ? "true" : "false"}`,
- ).catch((err) =>
- console.error(`Error revalidating link ${link.id}:`, err),
- ),
- ),
- );
- } catch (error) {
- console.error(
- `Error revalidating links for dataroom ${dataroomId}:`,
- error,
- );
- }
-}
-
export default async function handler(
req: NextApiRequest,
res: NextApiResponse,
@@ -158,7 +119,7 @@ export default async function handler(
documentId: { in: documentIds },
dataroomId,
},
- select: { id: true, documentId: true, folderId: true },
+ select: { id: true, folderId: true },
});
if (dataroomDocuments.length === 0) {
@@ -167,26 +128,18 @@ export default async function handler(
.json({ message: "No documents found in this dataroom" });
}
- // Apply each strategy independently to its target group type
- await Promise.all([
- applyPermissionStrategy({
- dataroomId,
- dataroomDocuments,
- strategy: effectiveGroupStrategy,
- rootItemAccess: dataroom.defaultGroupRootItemAccess,
- target: "VIEWER_GROUP",
- }),
- applyPermissionStrategy({
- dataroomId,
- dataroomDocuments,
- strategy: effectiveLinkStrategy,
- rootItemAccess: dataroom.defaultRootItemAccess,
- target: "PERMISSION_GROUP",
- }),
- ]);
+ await applyDataroomDocumentPermissionDefaults({
+ dataroomId,
+ dataroomDocuments,
+ groupStrategy: effectiveGroupStrategy,
+ groupRootItemAccess: dataroom.defaultGroupRootItemAccess,
+ linkStrategy: effectiveLinkStrategy,
+ linkRootItemAccess: dataroom.defaultRootItemAccess,
+ });
- // Revalidate ISR pages for links with permission restrictions
- await revalidateLinksForDataroom(dataroomId);
+ // Revalidate ISR pages for links with permission restrictions off the
+ // request path so the response returns without waiting for it.
+ waitUntil(revalidateLinksForDataroom(dataroomId));
return res.status(200).json({
message: "Permissions applied successfully",
@@ -198,228 +151,3 @@ export default async function handler(
errorhandler(error, res);
}
}
-
-async function applyPermissionStrategy(opts: {
- dataroomId: string;
- dataroomDocuments: DataroomDocumentRef[];
- strategy: DefaultPermissionStrategy;
- rootItemAccess: RootItemAccess;
- target: GroupTarget;
-}) {
- const { dataroomId, dataroomDocuments, strategy, rootItemAccess, target } =
- opts;
-
- // ASK_EVERY_TIME and HIDDEN_BY_DEFAULT both intentionally leave the document
- // hidden until something else writes the access control rows (the unified
- // permissions modal for ASK_EVERY_TIME, manual configuration for
- // HIDDEN_BY_DEFAULT).
- if (strategy !== DefaultPermissionStrategy.INHERIT_FROM_PARENT) return;
-
- // Group documents by the folder they actually live in (server-side truth,
- // not the client-provided path). Root-level documents have no parent to
- // inherit from and get the dataroom's root-item default instead.
- const rootDocuments: DataroomDocumentRef[] = [];
- const documentsByFolderId = new Map<string, DataroomDocumentRef[]>();
- for (const doc of dataroomDocuments) {
- if (doc.folderId === null) {
- rootDocuments.push(doc);
- } else {
- const list = documentsByFolderId.get(doc.folderId) ?? [];
- list.push(doc);
- documentsByFolderId.set(doc.folderId, list);
- }
- }
-
- await Promise.all([
- rootDocuments.length > 0
- ? applyRootLevelPermissions(
- dataroomId,
- rootDocuments,
- rootItemAccess,
- target,
- )
- : Promise.resolve(),
- ...Array.from(documentsByFolderId, ([folderId, docs]) =>
- inheritFromContainingFolder(folderId, docs, target),
- ),
- ]);
-}
-
-/**
- * Upsert-equivalent for default-permission rows: remove any existing rows for
- * the exact (group, document) pairs we're about to write, then insert the new
- * values. Unlike `createMany({ skipDuplicates: true })`, a stale row (e.g.
- * `canView=false` left behind by an earlier write) is corrected instead of
- * silently kept.
- */
-async function upsertViewerGroupDocumentRows(
- data: {
- groupId: string;
- itemId: string;
- itemType: ItemType;
- canView: boolean;
- canDownload: boolean;
- }[],
-) {
- if (data.length === 0) return;
- const groupIds = Array.from(new Set(data.map((d) => d.groupId)));
- const itemIds = Array.from(new Set(data.map((d) => d.itemId)));
- await prisma.$transaction([
- prisma.viewerGroupAccessControls.deleteMany({
- where: {
- groupId: { in: groupIds },
- itemId: { in: itemIds },
- itemType: ItemType.DATAROOM_DOCUMENT,
- },
- }),
- prisma.viewerGroupAccessControls.createMany({ data }),
- ]);
-}
-
-async function upsertPermissionGroupDocumentRows(
- data: {
- groupId: string;
- itemId: string;
- itemType: ItemType;
- canView: boolean;
- canDownload: boolean;
- canDownloadOriginal: boolean;
- }[],
-) {
- if (data.length === 0) return;
- const groupIds = Array.from(new Set(data.map((d) => d.groupId)));
- const itemIds = Array.from(new Set(data.map((d) => d.itemId)));
- await prisma.$transaction([
- prisma.permissionGroupAccessControls.deleteMany({
- where: {
- groupId: { in: groupIds },
- itemId: { in: itemIds },
- itemType: ItemType.DATAROOM_DOCUMENT,
- },
- }),
- prisma.permissionGroupAccessControls.createMany({ data }),
- ]);
-}
-
-async function applyRootLevelPermissions(
- dataroomId: string,
- dataroomDocuments: DataroomDocumentRef[],
- rootItemAccess: RootItemAccess,
- target: GroupTarget,
-) {
- const flags = resolveRootItemAccessFlags(rootItemAccess);
- // HIDDEN: no rows are written, so the documents stay invisible until an
- // admin grants access explicitly.
- if (!flags) return;
-
- if (target === "VIEWER_GROUP") {
- const viewerGroups = await prisma.viewerGroup.findMany({
- where: { dataroomId },
- select: { id: true },
- });
- if (viewerGroups.length === 0) return;
-
- await upsertViewerGroupDocumentRows(
- viewerGroups.flatMap((group) =>
- dataroomDocuments.map((doc) => ({
- groupId: group.id,
- itemId: doc.id,
- itemType: ItemType.DATAROOM_DOCUMENT,
- canView: flags.canView,
- canDownload: flags.canDownload,
- })),
- ),
- );
- return;
- }
-
- const permissionGroups = await prisma.permissionGroup.findMany({
- where: { dataroomId },
- select: { id: true },
- });
- if (permissionGroups.length === 0) return;
-
- await upsertPermissionGroupDocumentRows(
- permissionGroups.flatMap((group) =>
- dataroomDocuments.map((doc) => ({
- groupId: group.id,
- itemId: doc.id,
- itemType: ItemType.DATAROOM_DOCUMENT,
- canView: flags.canView,
- canDownload: flags.canDownload,
- canDownloadOriginal: false,
- })),
- ),
- );
-}
-
-/**
- * Copies the ACLs of the folder the documents actually live in onto the
- * documents. Groups without a row on the folder get no row on the document
- * (not visible), mirroring the folder exactly.
- *
- * Note this intentionally reads the *containing* folder's permissions — a
- * previous version derived the parent from the client-supplied folder path
- * with an off-by-one (`slice(0, -1)`), inheriting from the grandparent and
- * leaving freshly uploaded documents without any viewable row.
- */
-async function inheritFromContainingFolder(
- folderId: string,
- dataroomDocuments: DataroomDocumentRef[],
- target: GroupTarget,
-) {
- if (target === "VIEWER_GROUP") {
- const folderPermissions = await prisma.viewerGroupAccessControls.findMany({
- where: {
- itemId: folderId,
- itemType: ItemType.DATAROOM_FOLDER,
- },
- select: { groupId: true, canView: true, canDownload: true },
- });
-
- if (folderPermissions.length === 0) return;
-
- await upsertViewerGroupDocumentRows(
- folderPermissions.flatMap((folderPerm) =>
- dataroomDocuments.map((doc) => ({
- groupId: folderPerm.groupId,
- itemId: doc.id,
- itemType: ItemType.DATAROOM_DOCUMENT,
- canView: folderPerm.canView,
- canDownload: folderPerm.canDownload,
- })),
- ),
- );
- return;
- }
-
- const folderPermissions = await prisma.permissionGroupAccessControls.findMany(
- {
- where: {
- itemId: folderId,
- itemType: ItemType.DATAROOM_FOLDER,
- },
- select: {
- groupId: true,
- canView: true,
- canDownload: true,
- canDownloadOriginal: true,
- },
- },
- );
-
- if (folderPermissions.length === 0) return;
-
- await upsertPermissionGroupDocumentRows(
- folderPermissions.flatMap((folderPerm) =>
- dataroomDocuments.map((doc) => ({
- groupId: folderPerm.groupId,
- itemId: doc.id,
- itemType: ItemType.DATAROOM_DOCUMENT,
- canView: folderPerm.canView,
- canDownload: folderPerm.canDownload,
- canDownloadOriginal: folderPerm.canDownloadOriginal,
- })),
- ),
- );
-}
diff --git a/pages/api/teams/[teamId]/datarooms/[id]/documents/index.ts b/pages/api/teams/[teamId]/datarooms/[id]/documents/index.ts
index 9e84e4ee..7f0d8379 100644
--- a/pages/api/teams/[teamId]/datarooms/[id]/documents/index.ts
+++ b/pages/api/teams/[teamId]/datarooms/[id]/documents/index.ts
@@ -12,6 +12,7 @@ import { waitUntil } from "@vercel/functions";
import { withTeamApi } from "@/lib/api/auth/with-session-team";
import { assertDocumentAccess } from "@/lib/api/rbac/entitlements";
import { isDataroomScopedRole } from "@/lib/api/rbac/permissions";
+import { onDataroomDocumentsAttached } from "@/lib/dataroom/apply-default-permissions";
import { errorhandler } from "@/lib/errorHandler";
import { getFeatureFlags } from "@/lib/featureFlags";
import prisma from "@/lib/prisma";
@@ -188,14 +189,22 @@ const postHandler = withTeamApi(
orderBy: { createdAt: "desc" },
take: 1,
},
- _count: {
- select: { viewerGroups: true, permissionGroups: true },
- },
},
},
},
});
+ await onDataroomDocumentsAttached({
+ dataroomId,
+ dataroomDocuments: [
+ {
+ id: dataroomDocument.id,
+ folderId: dataroomDocument.folderId,
+ },
+ ],
+ schedule: waitUntil,
+ });
+
// Auto-index document if dataroom has AI agents enabled
if (
dataroomDocument.dataroom.agentsEnabled &&
diff --git a/pages/api/teams/[teamId]/documents/[id]/add-to-dataroom.ts b/pages/api/teams/[teamId]/documents/[id]/add-to-dataroom.ts
index 62c60614..ad1aef67 100644
--- a/pages/api/teams/[teamId]/documents/[id]/add-to-dataroom.ts
+++ b/pages/api/teams/[teamId]/documents/[id]/add-to-dataroom.ts
@@ -1,17 +1,18 @@
import { NextApiRequest, NextApiResponse } from "next";
import {
+ SUPPORTED_AI_CONTENT_TYPES,
addFileToVectorStoreTask,
processDocumentForAITask,
- SUPPORTED_AI_CONTENT_TYPES,
} from "@/ee/features/ai/lib/trigger";
import { waitUntil } from "@vercel/functions";
import { withTeamApi } from "@/lib/api/auth/with-session-team";
import { assertDocumentAccess } from "@/lib/api/rbac/entitlements";
import { isDataroomScopedRole } from "@/lib/api/rbac/permissions";
-import { getFeatureFlags } from "@/lib/featureFlags";
+import { onDataroomDocumentsAttached } from "@/lib/dataroom/apply-default-permissions";
import { errorhandler } from "@/lib/errorHandler";
+import { getFeatureFlags } from "@/lib/featureFlags";
import prisma from "@/lib/prisma";
export const config = {
@@ -121,6 +122,17 @@ const postHandler = withTeamApi(
});
}
+ await onDataroomDocumentsAttached({
+ dataroomId: dataroom.id,
+ dataroomDocuments: [
+ {
+ id: dataroomDocument.id,
+ folderId: dataroomDocument.folderId,
+ },
+ ],
+ schedule: waitUntil,
+ });
+
// Auto-index document if dataroom has AI agents enabled
if (dataroom.agentsEnabled && dataroom.vectorStoreId) {
const primaryVersion = document.versions[0];
@@ -129,7 +141,11 @@ const postHandler = withTeamApi(
// Check if AI feature is enabled for the team
const features = await getFeatureFlags({ teamId });
- if (features.ai && primaryVersion && SUPPORTED_AI_CONTENT_TYPES.includes(contentType)) {
+ if (
+ features.ai &&
+ primaryVersion &&
+ SUPPORTED_AI_CONTENT_TYPES.includes(contentType)
+ ) {
const filePath =
primaryVersion.originalFile && contentType !== "application/pdf"
? primaryVersion.originalFile
diff --git a/pages/api/webhooks/services/[...path]/index.ts b/pages/api/webhooks/services/[...path]/index.ts
index 84b2fb53..27f664d9 100644
--- a/pages/api/webhooks/services/[...path]/index.ts
+++ b/pages/api/webhooks/services/[...path]/index.ts
@@ -7,6 +7,7 @@ import { waitUntil } from "@vercel/functions";
import { z } from "zod";
import { hashToken } from "@/lib/api/auth/token";
+import { onDataroomDocumentsAttached } from "@/lib/dataroom/apply-default-permissions";
import {
createDocument,
createNewDocumentVersion,
@@ -28,8 +29,8 @@ import {
getSupportedContentType,
} from "@/lib/utils/get-content-type";
import {
- fetchPublicHttpsUrlToBuffer,
type PublicHttpsDownload,
+ fetchPublicHttpsUrlToBuffer,
} from "@/lib/utils/ssrf-protection";
import { sendLinkCreatedWebhook } from "@/lib/webhook/triggers/link-created";
import { webhookFileUrlSchema } from "@/lib/zod/url-validation";
@@ -41,6 +42,9 @@ export const config = {
};
const MAX_WEBHOOK_FILE_BYTES = 100 * 1024 * 1024;
+const API_DOCS_URL = "https://www.papermark.com/docs/api";
+const LEGACY_API_NOTICE =
+ `This endpoint is deprecated; use the v1 API: ${API_DOCS_URL}`;
// Define a common link schema to reuse
const LinkSchema = z.object({
@@ -142,6 +146,10 @@ export default async function incomingWebhookHandler(
req: NextApiRequest,
res: NextApiResponse,
) {
+ res.setHeader("Deprecation", "true");
+ res.setHeader("Link", `<${API_DOCS_URL}>; rel="successor-version"`);
+ res.setHeader("X-Papermark-API-Notice", LEGACY_API_NOTICE);
+
if (req.method !== "POST") {
return res.status(405).json({ error: "Method not allowed" });
}
@@ -631,7 +639,9 @@ async function handleDocumentCreate(
enableFeedback: link.enableFeedback,
enableScreenshotProtection: link.enableScreenshotProtection,
enableConfidentialView:
- link.enableConfidentialView ?? preset?.enableConfidentialView ?? false,
+ link.enableConfidentialView ??
+ preset?.enableConfidentialView ??
+ false,
showBanner: link.showBanner ?? preset?.showBanner ?? false,
audienceType: link.audienceType,
groupId: isGroupAudience ? link.groupId : null,
@@ -682,13 +692,24 @@ async function handleDocumentCreate(
}
}
- await prisma.dataroomDocument.create({
+ const newDataroomDocument = await prisma.dataroomDocument.create({
data: {
dataroomId,
documentId: document.id,
folderId: dataroomFolderId || null,
},
});
+
+ await onDataroomDocumentsAttached({
+ dataroomId,
+ dataroomDocuments: [
+ {
+ id: newDataroomDocument.id,
+ folderId: newDataroomDocument.folderId,
+ },
+ ],
+ schedule: waitUntil,
+ });
}
return res.status(200).json({
@@ -839,9 +860,7 @@ async function handleDocumentUpdate(
});
} catch (error) {
console.error("Document update error:", error);
- return res
- .status(500)
- .json({ error: "Failed to create document version" });
+ return res.status(500).json({ error: "Failed to create document version" });
}
}
@@ -1011,7 +1030,9 @@ async function handleLinkCreate(
enableFeedback: link.enableFeedback,
enableScreenshotProtection: link.enableScreenshotProtection,
enableConfidentialView:
- link.enableConfidentialView ?? preset?.enableConfidentialView ?? false,
+ link.enableConfidentialView ??
+ preset?.enableConfidentialView ??
+ false,
showBanner: link.showBanner ?? preset?.showBanner ?? false,
audienceType: link.audienceType,
groupId: isGroupAudience ? link.groupId : null,
@@ -1513,7 +1534,9 @@ async function handleDataroomCreate(
enableFeedback: link.enableFeedback,
enableScreenshotProtection: link.enableScreenshotProtection,
enableConfidentialView:
- link.enableConfidentialView ?? preset?.enableConfidentialView ?? false,
+ link.enableConfidentialView ??
+ preset?.enableConfidentialView ??
+ false,
showBanner: link.showBanner ?? preset?.showBanner ?? false,
audienceType: link.audienceType,
groupId: isGroupAudience ? link.groupId : null,