Link folders

apps/web/app/api/analytics/export/route.ts

@@ -5,18 +5,19 @@ import { getDomainOrThrow } from "@/lib/api/domains/get-domain-or-throw";
 import { getLinkOrThrow } from "@/lib/api/links/get-link-or-throw";
 import { throwIfClicksUsageExceeded } from "@/lib/api/links/usage-checks";
 import { withWorkspace } from "@/lib/auth";
+import { checkFolderPermission } from "@/lib/folder/permissions";
 import { analyticsQuerySchema } from "@/lib/zod/schemas/analytics";
 import { Link } from "@dub/prisma/client";
 import JSZip from "jszip";
 
 // GET /api/analytics/export – get export data for analytics
 export const GET = withWorkspace(
-  async ({ searchParams, workspace }) => {
+  async ({ searchParams, workspace, session }) => {
     throwIfClicksUsageExceeded(workspace);
 
     const parsedParams = analyticsQuerySchema.parse(searchParams);
 
-    const { interval, start, end, linkId, externalId, domain, key } =
+    const { interval, start, end, linkId, externalId, domain, key, folderId } =
       parsedParams;
 
     let link: Link | null = null;
@@ -35,6 +36,30 @@ export const GET = withWorkspace(
       });
     }
 
+    await Promise.all([
+      ...(link && link.folderId
+        ? [
+            checkFolderPermission({
+              workspaceId: workspace.id,
+              userId: session.user.id,
+              folderId: link.folderId,
+              requiredPermission: "folders.read",
+            }),
+          ]
+        : []),
+
+      ...(folderId
+        ? [
+            checkFolderPermission({
+              workspaceId: workspace.id,
+              userId: session.user.id,
+              folderId,
+              requiredPermission: "folders.read",
+            }),
+          ]
+        : []),
+    ]);
+
     validDateRangeForPlan({
       plan: workspace.plan,
       interval,
@@ -60,6 +85,7 @@ export const GET = withWorkspace(
           event: "clicks",
           groupBy: endpoint,
         });
+
         if (!response || response.length === 0) return;
 
         const csvData = convertToCSV(response);

apps/web/app/api/analytics/route.ts

@@ -5,6 +5,7 @@ import { getDomainOrThrow } from "@/lib/api/domains/get-domain-or-throw";
 import { getLinkOrThrow } from "@/lib/api/links/get-link-or-throw";
 import { throwIfClicksUsageExceeded } from "@/lib/api/links/usage-checks";
 import { withWorkspace } from "@/lib/auth";
+import { checkFolderPermission } from "@/lib/folder/permissions";
 import {
   analyticsPathParamsSchema,
   analyticsQuerySchema,
@@ -14,7 +15,7 @@ import { NextResponse } from "next/server";
 
 // GET /api/analytics – get analytics
 export const GET = withWorkspace(
-  async ({ params, searchParams, workspace }) => {
+  async ({ params, searchParams, workspace, session }) => {
     throwIfClicksUsageExceeded(workspace);
 
     let { eventType: oldEvent, endpoint: oldType } =
@@ -38,9 +39,14 @@ export const GET = withWorkspace(
       externalId,
       domain,
       key,
+      folderId,
     } = parsedParams;
+
     let link: Link | null = null;
 
+    event = oldEvent || event;
+    groupBy = oldType || groupBy;
+
     if (domain) {
       await getDomainOrThrow({ workspace, domain });
     }
@@ -55,8 +61,29 @@ export const GET = withWorkspace(
       });
     }
 
-    event = oldEvent || event;
-    groupBy = oldType || groupBy;
+    await Promise.all([
+      ...(link && link.folderId
+        ? [
+            checkFolderPermission({
+              workspaceId: workspace.id,
+              userId: session.user.id,
+              folderId: link.folderId,
+              requiredPermission: "folders.read",
+            }),
+          ]
+        : []),
+
+      ...(folderId
+        ? [
+            checkFolderPermission({
+              workspaceId: workspace.id,
+              userId: session.user.id,
+              folderId,
+              requiredPermission: "folders.read",
+            }),
+          ]
+        : []),
+    ]);
 
     validDateRangeForPlan({
       plan: workspace.plan,

apps/web/app/api/events/export/route.ts

@@ -4,6 +4,7 @@ import { getDomainOrThrow } from "@/lib/api/domains/get-domain-or-throw";
 import { getLinkOrThrow } from "@/lib/api/links/get-link-or-throw";
 import { throwIfClicksUsageExceeded } from "@/lib/api/links/usage-checks";
 import { withWorkspace } from "@/lib/auth";
+import { checkFolderPermission } from "@/lib/folder/permissions";
 import { ClickEvent, LeadEvent, SaleEvent } from "@/lib/types";
 import { eventsQuerySchema } from "@/lib/zod/schemas/analytics";
 import { COUNTRIES, capitalize } from "@dub/utils";
@@ -33,7 +34,7 @@ const columnAccessors = {
 
 // GET /api/events/export – get export data for analytics
 export const GET = withWorkspace(
-  async ({ searchParams, workspace }) => {
+  async ({ searchParams, workspace, session }) => {
     throwIfClicksUsageExceeded(workspace);
 
     const parsedParams = eventsQuerySchema
@@ -47,7 +48,8 @@ export const GET = withWorkspace(
       )
       .parse(searchParams);
 
-    const { event, domain, interval, start, end, columns, key } = parsedParams;
+    const { event, domain, interval, start, end, columns, key, folderId } =
+      parsedParams;
 
     if (domain) {
       await getDomainOrThrow({ workspace, domain });
@@ -58,6 +60,30 @@ export const GET = withWorkspace(
         ? await getLinkOrThrow({ workspaceId: workspace.id, domain, key })
         : null;
 
+    await Promise.all([
+      ...(link && link.folderId
+        ? [
+            checkFolderPermission({
+              workspaceId: workspace.id,
+              userId: session.user.id,
+              folderId: link.folderId,
+              requiredPermission: "folders.read",
+            }),
+          ]
+        : []),
+
+      ...(folderId
+        ? [
+            checkFolderPermission({
+              workspaceId: workspace.id,
+              userId: session.user.id,
+              folderId,
+              requiredPermission: "folders.read",
+            }),
+          ]
+        : []),
+    ]);
+
     validDateRangeForPlan({
       plan: workspace.plan,
       interval,

apps/web/app/api/events/route.ts

@@ -4,18 +4,29 @@ import { getDomainOrThrow } from "@/lib/api/domains/get-domain-or-throw";
 import { getLinkOrThrow } from "@/lib/api/links/get-link-or-throw";
 import { throwIfClicksUsageExceeded } from "@/lib/api/links/usage-checks";
 import { withWorkspace } from "@/lib/auth";
+import { checkFolderPermission } from "@/lib/folder/permissions";
 import { eventsQuerySchema } from "@/lib/zod/schemas/analytics";
 import { Link } from "@dub/prisma/client";
 import { NextResponse } from "next/server";
 
 export const GET = withWorkspace(
-  async ({ searchParams, workspace }) => {
+  async ({ searchParams, workspace, session }) => {
     throwIfClicksUsageExceeded(workspace);
 
     const parsedParams = eventsQuerySchema.parse(searchParams);
 
-    let { event, interval, start, end, linkId, externalId, domain, key } =
-      parsedParams;
+    let {
+      event,
+      interval,
+      start,
+      end,
+      linkId,
+      externalId,
+      domain,
+      key,
+      folderId,
+    } = parsedParams;
+
     let link: Link | null = null;
 
     if (domain) {
@@ -32,6 +43,30 @@ export const GET = withWorkspace(
       });
     }
 
+    await Promise.all([
+      ...(link && link.folderId
+        ? [
+            checkFolderPermission({
+              workspaceId: workspace.id,
+              userId: session.user.id,
+              folderId: link.folderId,
+              requiredPermission: "folders.read",
+            }),
+          ]
+        : []),
+
+      ...(folderId
+        ? [
+            checkFolderPermission({
+              workspaceId: workspace.id,
+              userId: session.user.id,
+              folderId,
+              requiredPermission: "folders.read",
+            }),
+          ]
+        : []),
+    ]);
+
     validDateRangeForPlan({
       plan: workspace.plan,
       interval,

apps/web/app/api/folders/[folderId]/route.ts

@@ -0,0 +1,129 @@
+import { DubApiError } from "@/lib/api/errors";
+import { parseRequestBody } from "@/lib/api/utils";
+import { withWorkspace } from "@/lib/auth";
+import { checkFolderPermission } from "@/lib/folder/permissions";
+import { recordLink } from "@/lib/tinybird";
+import { FolderSchema, updateFolderSchema } from "@/lib/zod/schemas/folders";
+import { prisma } from "@dub/prisma";
+import { waitUntil } from "@vercel/functions";
+import { NextResponse } from "next/server";
+
+// GET /api/folders/[folderId] - get information about a folder
+export const GET = withWorkspace(
+  async ({ params, workspace, session }) => {
+    const { folderId } = params;
+
+    const folder = await checkFolderPermission({
+      folderId,
+      workspaceId: workspace.id,
+      userId: session.user.id,
+      requiredPermission: "folders.read",
+    });
+
+    return NextResponse.json(FolderSchema.parse(folder));
+  },
+  {
+    requiredPermissions: ["folders.read"],
+  },
+);
+
+// PATCH /api/folders/[folderId] – update a folder for a workspace
+export const PATCH = withWorkspace(
+  async ({ req, params, workspace, session }) => {
+    const { folderId } = params;
+
+    const { name, accessLevel } = updateFolderSchema.parse(
+      await parseRequestBody(req),
+    );
+
+    await checkFolderPermission({
+      workspaceId: workspace.id,
+      userId: session.user.id,
+      folderId,
+      requiredPermission: "folders.write",
+    });
+
+    try {
+      const updatedFolder = await prisma.folder.update({
+        where: {
+          id: folderId,
+          projectId: workspace.id,
+        },
+        data: {
+          name,
+          accessLevel,
+        },
+      });
+
+      return NextResponse.json(FolderSchema.parse(updatedFolder));
+    } catch (error) {
+      if (error.code === "P2002") {
+        throw new DubApiError({
+          code: "conflict",
+          message: `A folder with the name "${name}" already exists.`,
+        });
+      }
+
+      throw error;
+    }
+  },
+  {
+    requiredPermissions: ["folders.write"],
+  },
+);
+
+// DELETE /api/folders/[folderId] – delete a folder for a workspace
+export const DELETE = withWorkspace(
+  async ({ params, workspace, session }) => {
+    const { folderId } = params;
+
+    await checkFolderPermission({
+      workspaceId: workspace.id,
+      userId: session.user.id,
+      folderId,
+      requiredPermission: "folders.write",
+    });
+
+    const deletedFolder = await prisma.folder.delete({
+      where: {
+        id: folderId,
+        projectId: workspace.id,
+      },
+      include: {
+        links: {
+          include: {
+            tags: {
+              include: {
+                tag: true,
+              },
+            },
+          },
+        },
+      },
+    });
+
+    waitUntil(
+      (async () => {
+        const links = deletedFolder.links;
+
+        // TODO:
+        // Handle this via background job if number of links is huge
+        if (links.length > 0) {
+          recordLink(
+            links.map((link) => {
+              return {
+                ...link,
+                folderId: null,
+              };
+            }),
+          );
+        }
+      })(),
+    );
+
+    return NextResponse.json({ id: folderId });
+  },
+  {
+    requiredPermissions: ["folders.write"],
+  },
+);