Skip to content

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

feat: add sidebar component for file / folder tree

Marc Seitz0521c23796be
diff --git a/components/sidebar-folders.tsx b/components/sidebar-folders.tsx
index b345ae8b..63de9bc4 100644
--- a/components/sidebar-folders.tsx
+++ b/components/sidebar-folders.tsx
@@ -1,42 +1,91 @@
import { useRouter } from "next/router";
import { FileTree } from "./ui/nextra-filetree";
+import { FolderWithDocuments, useFolders } from "@/lib/swr/use-documents";
+import { memo, useMemo } from "react";
-export default function SidebarFolders() {
+// Helper function to build nested folder structure
+const buildNestedFolderStructure = (folders: FolderWithDocuments[]) => {
+ const folderMap = new Map();
+
+ // Initialize every folder with an additional childFolders property
+ folders.forEach((folder) => {
+ folderMap.set(folder.id, { ...folder, childFolders: [] });
+ });
+
+ const rootFolders: FolderWithDocuments[] = [];
+
+ folderMap.forEach((folder, id) => {
+ if (folder.parentId) {
+ const parent = folderMap.get(folder.parentId);
+ parent.childFolders.push(folder);
+ } else {
+ rootFolders.push(folder);
+ }
+ });
+
+ return rootFolders;
+};
+
+const FolderComponent = memo(({ folder }: { folder: FolderWithDocuments }) => {
const router = useRouter();
+
+ // Memoize the rendering of the current folder's documents
+ const documents = useMemo(
+ () =>
+ folder.documents.map((doc) => (
+ <FileTree.File
+ key={doc.id}
+ name={doc.name}
+ onToggle={() => router.push(`/documents/${doc.id}`)}
+ />
+ )),
+ [folder.documents, router.query.name],
+ );
+
+ // Recursively render child folders if they exist
+ const childFolders = useMemo(
+ () =>
+ folder.childFolders.map((childFolder) => (
+ <FolderComponent key={childFolder.id} folder={childFolder} />
+ )),
+ [folder.childFolders],
+ );
+
+ return (
+ <FileTree.Folder
+ name={folder.name}
+ key={folder.id}
+ active={folder.path === "/" + (router.query.name as string[]).join("/")}
+ childActive={router.query.name?.includes(folder.name)}
+ onToggle={() => router.push(`/documents/tree${folder.path}`)}
+ >
+ {childFolders}
+ {documents}
+ </FileTree.Folder>
+ );
+});
+
+const SidebarFolders = ({ folders }: { folders: FolderWithDocuments[] }) => {
+ const nestedFolders = useMemo(() => {
+ if (folders) {
+ return buildNestedFolderStructure(folders);
+ }
+ return [];
+ }, [folders]);
+
return (
<FileTree>
- <FileTree.Folder
- name="pages"
- defaultOpen
- active={router.query.name === "pages"}
- >
- <FileTree.File name="contact.md" />
- <FileTree.File name="index.mdx" />
- <FileTree.Folder name="about">
- <FileTree.File name="legal.md" />
- <FileTree.File name="index.mdx" />
- <FileTree.Folder name="pages">
- <FileTree.File name="legal.md" />
- <FileTree.File name="index.mdx" />
- <FileTree.Folder name="pages">
- <FileTree.File name="legal.md" />
- <FileTree.File name="index.mdx" />
- <FileTree.Folder name="pages">
- <FileTree.File name="legal.md" />
- <FileTree.File name="index.mdx" />
- <FileTree.Folder name="pages">
- <FileTree.File name="legal.md" />
- <FileTree.File name="index.mdx" />
- </FileTree.Folder>
- </FileTree.Folder>
- </FileTree.Folder>
- </FileTree.Folder>
- </FileTree.Folder>
- </FileTree.Folder>
- <FileTree.Folder name="pages">
- <FileTree.File name="legal.md" />
- <FileTree.File name="index.mdx" />
- </FileTree.Folder>
+ {nestedFolders.map((folder) => (
+ <FolderComponent key={folder.id} folder={folder} />
+ ))}
</FileTree>
);
+};
+
+export default function SidebarFolderTree() {
+ const { folders, error } = useFolders();
+
+ if (!folders || error) return null;
+
+ return <SidebarFolders folders={folders} />;
}
diff --git a/components/ui/nextra-filetree.tsx b/components/ui/nextra-filetree.tsx
index 13a661c5..3178f995 100644
--- a/components/ui/nextra-filetree.tsx
+++ b/components/ui/nextra-filetree.tsx
@@ -22,6 +22,7 @@ interface FolderProps {
open?: boolean;
defaultOpen?: boolean;
active?: boolean;
+ childActive?: boolean;
onToggle?: (open: boolean) => void;
children: ReactNode;
}
@@ -30,6 +31,7 @@ interface FileProps {
name: string;
label?: ReactElement;
active?: boolean;
+ onToggle?: (active: boolean) => void;
}
function Tree({ children }: { children: ReactNode }): ReactElement {
@@ -52,9 +54,18 @@ function Ident(): ReactElement {
}
const Folder = memo<FolderProps>(
- ({ label, name, open, children, active, defaultOpen = false, onToggle }) => {
+ ({
+ label,
+ name,
+ open,
+ children,
+ active,
+ childActive,
+ defaultOpen = false,
+ onToggle,
+ }) => {
const indent = useIndent();
- const [isOpen, setIsOpen] = useState(defaultOpen);
+ const [isOpen, setIsOpen] = useState(defaultOpen || active || childActive);
const toggle = useCallback(() => {
onToggle?.(!isOpen);
@@ -120,18 +131,26 @@ const Folder = memo<FolderProps>(
);
Folder.displayName = "Folder";
-const File = memo<FileProps>(({ label, name, active }) => (
- <li
- className={cn(
- "flex list-none",
- active && "text-primary-600 contrast-more:underline",
- "text-foreground hover:bg-gray-200 hover:dark:bg-muted duration-100 rounded-md",
- "px-3",
- )}
- >
- <span className="inline-flex cursor-default items-center py-1">
- <Ident />
- {/* <svg width="1em" height="1em" viewBox="0 0 24 24">
+const File = memo<FileProps>(({ label, name, active, onToggle }) => {
+ const toggle = useCallback(() => {
+ onToggle?.(!active);
+ }, [onToggle]);
+
+ return (
+ <li
+ className={cn(
+ "flex list-none",
+ "text-foreground hover:bg-gray-200 hover:dark:bg-muted duration-100 rounded-md",
+ "px-3",
+ active && "bg-gray-200 dark:bg-muted font-semibold",
+ )}
+ >
+ <span
+ className="inline-flex cursor-default items-center py-1"
+ onClick={toggle}
+ >
+ <Ident />
+ {/* <svg width="1em" height="1em" viewBox="0 0 24 24">
<path
fill="none"
stroke="currentColor"
@@ -141,11 +160,12 @@ const File = memo<FileProps>(({ label, name, active }) => (
d="M9 12h6m-6 4h6m2 5H7a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h5.586a1 1 0 0 1 .707.293l5.414 5.414a1 1 0 0 1 .293.707V19a2 2 0 0 1-2 2Z"
/>
</svg> */}
- <FileIcon className="h-4 w-4 shrink-0" aria-hidden="true" />
- <span className="ml-2">{label ?? name}</span>
- </span>
- </li>
-));
+ <FileIcon className="h-4 w-4 shrink-0" aria-hidden="true" />
+ <span className="ml-2">{label ?? name}</span>
+ </span>
+ </li>
+ );
+});
File.displayName = "File";
export const FileTree = Object.assign(Tree, { Folder, File });
diff --git a/lib/swr/use-documents.ts b/lib/swr/use-documents.ts
index ee376bc5..e6c05f64 100644
--- a/lib/swr/use-documents.ts
+++ b/lib/swr/use-documents.ts
@@ -24,3 +24,32 @@ export default function useDocuments() {
error,
};
}
+
+export type FolderWithDocuments = Folder & {
+ childFolders: FolderWithDocuments[];
+ documents: {
+ id: string;
+ name: string;
+ folderId: string;
+ }[];
+};
+
+export function useFolders() {
+ const teamInfo = useTeam();
+
+ const { data: folders, error } = useSWR<FolderWithDocuments[]>(
+ teamInfo?.currentTeam?.id &&
+ `/api/teams/${teamInfo?.currentTeam?.id}/folders`,
+ fetcher,
+ {
+ revalidateOnFocus: false,
+ dedupingInterval: 30000,
+ },
+ );
+
+ return {
+ folders,
+ loading: !folders && !error,
+ error,
+ };
+}
diff --git a/pages/api/teams/[teamId]/folders/index.ts b/pages/api/teams/[teamId]/folders/index.ts
new file mode 100644
index 00000000..81ebfd28
--- /dev/null
+++ b/pages/api/teams/[teamId]/folders/index.ts
@@ -0,0 +1,74 @@
+import { NextApiRequest, NextApiResponse } from "next";
+import { getServerSession } from "next-auth/next";
+import prisma from "@/lib/prisma";
+import { authOptions } from "@/pages/api/auth/[...nextauth]";
+import { CustomUser } from "@/lib/types";
+
+export default async function handle(
+ req: NextApiRequest,
+ res: NextApiResponse,
+) {
+ if (req.method === "GET") {
+ // GET /api/teams/:teamId/folders
+ const session = await getServerSession(req, res, authOptions);
+ if (!session) {
+ return res.status(401).end("Unauthorized");
+ }
+
+ const userId = (session.user as CustomUser).id;
+ const { teamId } = req.query as { teamId: string };
+
+ try {
+ // Check if the user is part of the team
+ const team = await prisma.team.findUnique({
+ where: {
+ id: teamId,
+ users: {
+ some: {
+ userId: userId,
+ },
+ },
+ },
+ });
+
+ if (!team) {
+ return res.status(401).end("Unauthorized");
+ }
+
+ const folders = await prisma.folder.findMany({
+ where: {
+ teamId: teamId,
+ },
+ include: {
+ documents: {
+ select: {
+ id: true,
+ name: true,
+ folderId: true,
+ },
+ },
+ childFolders: {
+ include: {
+ documents: {
+ select: {
+ id: true,
+ name: true,
+ folderId: true,
+ },
+ },
+ },
+ },
+ },
+ });
+
+ return res.status(200).json(folders);
+ } catch (error) {
+ console.error("Request error", error);
+ return res.status(500).json({ error: "Error fetching folders" });
+ }
+ } else {
+ // We only allow POST requests
+ res.setHeader("Allow", ["GET", "POST"]);
+ return res.status(405).end(`Method ${req.method} Not Allowed`);
+ }
+}