Merge pull request #457 from linkwarden/feat/sub-collections

Feat/sub collections

components/CollectionSelection.tsx

@@ -0,0 +1,160 @@
+import useCollectionStore from "@/store/collections";
+import { CollectionIncludingMembersAndLinkCount } from "@/types/global";
+import Link from "next/link";
+import { useRouter } from "next/router";
+import React, { useEffect, useState } from "react";
+
+type Props = {
+  links: boolean;
+};
+
+const CollectionSelection = ({ links }: Props) => {
+  const { collections } = useCollectionStore();
+  const [active, setActive] = useState("");
+  const router = useRouter();
+
+  useEffect(() => {
+    setActive(router.asPath);
+  }, [router, collections]);
+
+  return (
+    <div>
+      {collections[0] ? (
+        collections
+          .sort((a, b) => a.name.localeCompare(b.name))
+          .filter((e) => e.parentId === null)
+          .map((e, i) => (
+            <CollectionItem
+              key={i}
+              collection={e}
+              active={active}
+              collections={collections}
+            />
+          ))
+      ) : (
+        <div
+          className={`duration-100 py-1 px-2 flex items-center gap-2 w-full rounded-md h-8 capitalize`}
+        >
+          <p className="text-neutral text-xs font-semibold truncate w-full pr-7">
+            You Have No Collections...
+          </p>
+        </div>
+      )}
+    </div>
+  );
+};
+
+export default CollectionSelection;
+
+const CollectionItem = ({
+  collection,
+  active,
+  collections,
+}: {
+  collection: CollectionIncludingMembersAndLinkCount;
+  active: string;
+  collections: CollectionIncludingMembersAndLinkCount[];
+}) => {
+  const hasChildren = collections.some((e) => e.parentId === collection.id);
+
+  const router = useRouter();
+
+  // Check if the current collection or any of its subcollections is active
+  const isActiveOrParentOfActive = React.useMemo(() => {
+    const isActive = active === `/collections/${collection.id}`;
+    if (isActive) return true;
+
+    const checkIfParentOfActive = (parentId: number): boolean => {
+      return collections.some((e) => {
+        if (e.id === parseInt(active.split("/collections/")[1])) {
+          if (e.parentId === parentId) return true;
+          if (e.parentId) return checkIfParentOfActive(e.parentId);
+        }
+        return false;
+      });
+    };
+
+    return checkIfParentOfActive(collection.id as number);
+  }, [active, collection.id, collections]);
+
+  const [isOpen, setIsOpen] = useState(isActiveOrParentOfActive);
+
+  useEffect(() => {
+    setIsOpen(isActiveOrParentOfActive);
+  }, [isActiveOrParentOfActive]);
+
+  return hasChildren ? (
+    <details open={isOpen}>
+      <summary
+        className={`${
+          active === `/collections/${collection.id}`
+            ? "bg-primary/20"
+            : "hover:bg-neutral/20"
+        } duration-100 rounded-md flex w-full items-center cursor-pointer mb-1 px-2`}
+      >
+        <Link href={`/collections/${collection.id}`} className="w-full">
+          <div
+            className={`py-1 cursor-pointer flex items-center gap-2 w-full h-8 capitalize`}
+          >
+            <i
+              className="bi-folder-fill text-2xl drop-shadow"
+              style={{ color: collection.color }}
+            ></i>
+            <p className="truncate w-full">{collection.name}</p>
+
+            {collection.isPublic ? (
+              <i
+                className="bi-globe2 text-sm text-black/50 dark:text-white/50 drop-shadow"
+                title="This collection is being shared publicly."
+              ></i>
+            ) : undefined}
+            <div className="drop-shadow text-neutral text-xs">
+              {collection._count?.links}
+            </div>
+          </div>
+        </Link>
+      </summary>
+
+      {hasChildren && (
+        <div className="ml-3 pl-1 border-l border-neutral-content">
+          {collections
+            .filter((e) => e.parentId === collection.id)
+            .map((subCollection) => (
+              <CollectionItem
+                key={subCollection.id}
+                collection={subCollection}
+                active={active}
+                collections={collections}
+              />
+            ))}
+        </div>
+      )}
+    </details>
+  ) : (
+    <Link href={`/collections/${collection.id}`} className="w-full">
+      <div
+        className={`${
+          active === `/collections/${collection.id}`
+            ? "bg-primary/20"
+            : "hover:bg-neutral/20"
+        } duration-100 py-1 px-2 cursor-pointer flex items-center gap-2 w-full rounded-md h-8 capitalize mb-1`}
+      >
+        <i
+          className="bi-folder-fill text-2xl drop-shadow"
+          style={{ color: collection.color }}
+        ></i>
+        <p className="truncate w-full">{collection.name}</p>
+
+        {collection.isPublic ? (
+          <i
+            className="bi-globe2 text-sm text-black/50 dark:text-white/50 drop-shadow"
+            title="This collection is being shared publicly."
+          ></i>
+        ) : undefined}
+        <div className="drop-shadow text-neutral text-xs">
+          {collection._count?.links}
+        </div>
+      </div>
+    </Link>
+  );
+};

components/ModalContent/NewCollectionModal.tsx

@@ -5,17 +5,20 @@ import toast from "react-hot-toast";
 import { HexColorPicker } from "react-colorful";
 import { Collection } from "@prisma/client";
 import Modal from "../Modal";
+import { CollectionIncludingMembersAndLinkCount } from "@/types/global";
 
 type Props = {
   onClose: Function;
+  parent?: CollectionIncludingMembersAndLinkCount;
 };
 
-export default function NewCollectionModal({ onClose }: Props) {
+export default function NewCollectionModal({ onClose, parent }: Props) {
   const initial = {
+    parentId: parent?.id,
     name: "",
     description: "",
     color: "#0ea5e9",
-  };
+  } as Partial<Collection>;
 
   const [collection, setCollection] = useState<Partial<Collection>>(initial);
 
@@ -47,7 +50,14 @@ export default function NewCollectionModal({ onClose }: Props) {
 
   return (
     <Modal toggleModal={onClose}>
-      <p className="text-xl font-thin">Create a New Collection</p>
+      {parent?.id ? (
+        <>
+          <p className="text-xl font-thin">New Sub-Collection</p>
+          <p className="capitalize text-sm">For {parent.name}</p>
+        </>
+      ) : (
+        <p className="text-xl font-thin">Create a New Collection</p>
+      )}
 
       <div className="divider mb-3 mt-1"></div>
 

components/ModalContent/NewLinkModal.tsx

@@ -179,7 +179,7 @@ export default function NewLinkModal({ onClose }: Props) {
                     setLink({ ...link, description: e.target.value })
                   }
                   placeholder="Will be auto generated if nothing is provided."
-                  className="resize-none w-full rounded-md p-2 border-neutral-content bg-base-200 focus:border-sky-300 dark:focus:border-sky-600 border-solid border outline-none duration-100"
+                  className="resize-none w-full rounded-md p-2 border-neutral-content bg-base-200 focus:border-primary border-solid border outline-none duration-100"
                 />
               </div>
             </div>

components/ModalContent/NewTokenModal.tsx

@@ -74,7 +74,7 @@ export default function NewTokenModal({ onClose }: Props) {
 
           <div className="divider mb-3 mt-1"></div>
 
-          <div className="flex gap-2 items-center">
+          <div className="flex sm:flex-row flex-col gap-2 items-center">
             <div className="w-full">
               <p className="mb-2">Name</p>
 
@@ -86,15 +86,15 @@ export default function NewTokenModal({ onClose }: Props) {
               />
             </div>
 
-            <div>
+            <div className="w-full sm:w-fit">
               <p className="mb-2">Expires in</p>
 
-              <div className="dropdown dropdown-bottom dropdown-end">
+              <div className="dropdown dropdown-bottom dropdown-end w-full">
                 <div
                   tabIndex={0}
                   role="button"
                   onMouseDown={dropdownTriggerer}
-                  className="btn btn-outline w-36 flex items-center btn-sm h-10"
+                  className="btn btn-outline w-full sm:w-36 flex items-center btn-sm h-10"
                 >
                   {token.expires === TokenExpiry.sevenDays && "7 Days"}
                   {token.expires === TokenExpiry.oneMonth && "30 Days"}
@@ -102,7 +102,7 @@ export default function NewTokenModal({ onClose }: Props) {
                   {token.expires === TokenExpiry.threeMonths && "90 Days"}
                   {token.expires === TokenExpiry.never && "No Expiration"}
                 </div>
-                <ul className="dropdown-content z-[30] menu shadow bg-base-200 border border-neutral-content rounded-xl w-52 mt-1">
+                <ul className="dropdown-content z-[30] menu shadow bg-base-200 border border-neutral-content rounded-xl w-full sm:w-52 mt-1">
                   <li>
                     <label
                       className="label cursor-pointer flex justify-start"
@@ -212,7 +212,7 @@ export default function NewTokenModal({ onClose }: Props) {
             </div>
           </div>
 
-          <div className="flex justify-between items-center mt-5">
+          <div className="flex justify-end items-center mt-5">
             <button
               className="btn btn-accent dark:border-violet-400 text-white"
               onClick={submit}

components/Sidebar.tsx

@@ -5,6 +5,7 @@ import { useRouter } from "next/router";
 import { useEffect, useState } from "react";
 import { Disclosure, Transition } from "@headlessui/react";
 import SidebarHighlightLink from "@/components/SidebarHighlightLink";
+import CollectionSelection from "@/components/CollectionSelection";
 
 export default function Sidebar({ className }: { className?: string }) {
   const [tagDisclosure, setTagDisclosure] = useState<boolean>(() => {
@@ -97,48 +98,8 @@ export default function Sidebar({ className }: { className?: string }) {
           leaveFrom="transform opacity-100 translate-y-0"
           leaveTo="transform opacity-0 -translate-y-3"
         >
-          <Disclosure.Panel className="flex flex-col gap-1">
-            {collections[0] ? (
-              collections
-                .sort((a, b) => a.name.localeCompare(b.name))
-                .map((e, i) => {
-                  return (
-                    <Link key={i} href={`/collections/${e.id}`}>
-                      <div
-                        className={`${
-                          active === `/collections/${e.id}`
-                            ? "bg-primary/20"
-                            : "hover:bg-neutral/20"
-                        } duration-100 py-1 px-2 cursor-pointer flex items-center gap-2 w-full rounded-md h-8 capitalize`}
-                      >
-                        <i
-                          className="bi-folder-fill text-2xl drop-shadow"
-                          style={{ color: e.color }}
-                        ></i>
-                        <p className="truncate w-full">{e.name}</p>
-
-                        {e.isPublic ? (
-                          <i
-                            className="bi-globe2 text-sm text-black/50 dark:text-white/50 drop-shadow"
-                            title="This collection is being shared publicly."
-                          ></i>
-                        ) : undefined}
-                        <div className="drop-shadow text-neutral text-xs">
-                          {e._count?.links}
-                        </div>
-                      </div>
-                    </Link>
-                  );
-                })
-            ) : (
-              <div
-                className={`duration-100 py-1 px-2 flex items-center gap-2 w-full rounded-md h-8 capitalize`}
-              >
-                <p className="text-neutral text-xs font-semibold truncate w-full pr-7">
-                  You Have No Collections...
-                </p>
-              </div>
-            )}
+          <Disclosure.Panel>
+            <CollectionSelection links={true} />
           </Disclosure.Panel>
         </Transition>
       </Disclosure>

lib/api/controllers/collections/collectionId/deleteCollectionById.ts

@@ -37,6 +37,8 @@ export default async function deleteCollection(
   }
 
   const deletedCollection = await prisma.$transaction(async () => {
+    await deleteSubCollections(collectionId);
+
     await prisma.usersAndCollections.deleteMany({
       where: {
         collection: {
@@ -53,7 +55,7 @@ export default async function deleteCollection(
       },
     });
 
-    removeFolder({ filePath: `archives/${collectionId}` });
+    await removeFolder({ filePath: `archives/${collectionId}` });
 
     return await prisma.collection.delete({
       where: {
@@ -64,3 +66,35 @@ export default async function deleteCollection(
 
   return { response: deletedCollection, status: 200 };
 }
+
+async function deleteSubCollections(collectionId: number) {
+  const subCollections = await prisma.collection.findMany({
+    where: { parentId: collectionId },
+  });
+
+  for (const subCollection of subCollections) {
+    await deleteSubCollections(subCollection.id);
+
+    await prisma.usersAndCollections.deleteMany({
+      where: {
+        collection: {
+          id: subCollection.id,
+        },
+      },
+    });
+
+    await prisma.link.deleteMany({
+      where: {
+        collection: {
+          id: subCollection.id,
+        },
+      },
+    });
+
+    await prisma.collection.delete({
+      where: { id: subCollection.id },
+    });
+
+    await removeFolder({ filePath: `archives/${subCollection.id}` });
+  }
+}

lib/api/controllers/collections/collectionId/getCollectionById.ts

@@ -0,0 +1,34 @@
+import { prisma } from "@/lib/api/db";
+
+export default async function getCollectionById(
+  userId: number,
+  collectionId: number
+) {
+  const collections = await prisma.collection.findFirst({
+    where: {
+      id: collectionId,
+      OR: [
+        { ownerId: userId },
+        { members: { some: { user: { id: userId } } } },
+      ],
+    },
+    include: {
+      _count: {
+        select: { links: true },
+      },
+      members: {
+        include: {
+          user: {
+            select: {
+              username: true,
+              name: true,
+              image: true,
+            },
+          },
+        },
+      },
+    },
+  });
+
+  return { response: collections, status: 200 };
+}

lib/api/controllers/collections/collectionId/updateCollectionById.ts

@@ -1,7 +1,6 @@
 import { prisma } from "@/lib/api/db";
 import { CollectionIncludingMembersAndLinkCount } from "@/types/global";
 import getPermission from "@/lib/api/getPermission";
-import { Collection, UsersAndCollections } from "@prisma/client";
 
 export default async function updateCollection(
   userId: number,
@@ -19,6 +18,26 @@ export default async function updateCollection(
   if (!(collectionIsAccessible?.ownerId === userId))
     return { response: "Collection is not accessible.", status: 401 };
 
+  if (data.parentId) {
+    const findParentCollection = await prisma.collection.findUnique({
+      where: {
+        id: data.parentId,
+      },
+      select: {
+        ownerId: true,
+      },
+    });
+
+    if (
+      findParentCollection?.ownerId !== userId ||
+      typeof data.parentId !== "number"
+    )
+      return {
+        response: "You are not authorized to create a sub-collection here.",
+        status: 403,
+      };
+  }
+
   const updatedCollection = await prisma.$transaction(async () => {
     await prisma.usersAndCollections.deleteMany({
       where: {
@@ -38,6 +57,11 @@ export default async function updateCollection(
         description: data.description,
         color: data.color,
         isPublic: data.isPublic,
+        parent: {
+          connect: {
+            id: data.parentId || undefined,
+          },
+        },
         members: {
           create: data.members.map((e) => ({
             user: { connect: { id: e.user.id || e.userId } },

lib/api/controllers/collections/postCollection.ts

@@ -12,6 +12,26 @@ export default async function postCollection(
       status: 400,
     };
 
+  if (collection.parentId) {
+    const findParentCollection = await prisma.collection.findUnique({
+      where: {
+        id: collection.parentId,
+      },
+      select: {
+        ownerId: true,
+      },
+    });
+
+    if (
+      findParentCollection?.ownerId !== userId ||
+      typeof collection.parentId !== "number"
+    )
+      return {
+        response: "You are not authorized to create a sub-collection here.",
+        status: 403,
+      };
+  }
+
   const findCollection = await prisma.user.findUnique({
     where: {
       id: userId,
@@ -28,7 +48,10 @@ export default async function postCollection(
   const checkIfCollectionExists = findCollection?.collections[0];
 
   if (checkIfCollectionExists)
-    return { response: "Collection already exists.", status: 400 };
+    return {
+      response: "Oops! There's already a Collection with that name.",
+      status: 400,
+    };
 
   const newCollection = await prisma.collection.create({
     data: {
@@ -40,6 +63,13 @@ export default async function postCollection(
       name: collection.name.trim(),
       description: collection.description,
       color: collection.color,
+      parent: collection.parentId
+        ? {
+            connect: {
+              id: collection.parentId,
+            },
+          }
+        : undefined,
     },
     include: {
       _count: {

pages/api/v1/collections/[id].ts

@@ -1,4 +1,5 @@
 import type { NextApiRequest, NextApiResponse } from "next";
+import getCollectionById from "@/lib/api/controllers/collections/collectionId/getCollectionById";
 import updateCollectionById from "@/lib/api/controllers/collections/collectionId/updateCollectionById";
 import deleteCollectionById from "@/lib/api/controllers/collections/collectionId/deleteCollectionById";
 import verifyUser from "@/lib/api/verifyUser";
@@ -10,18 +11,18 @@ export default async function collections(
   const user = await verifyUser({ req, res });
   if (!user) return;
 
-  if (req.method === "PUT") {
-    const updated = await updateCollectionById(
-      user.id,
-      Number(req.query.id) as number,
-      req.body
-    );
+  const collectionId = Number(req.query.id);
+
+  if (req.method === "GET") {
+    const collections = await getCollectionById(user.id, collectionId);
+    return res
+      .status(collections.status)
+      .json({ response: collections.response });
+  } else if (req.method === "PUT") {
+    const updated = await updateCollectionById(user.id, collectionId, req.body);
     return res.status(updated.status).json({ response: updated.response });
   } else if (req.method === "DELETE") {
-    const deleted = await deleteCollectionById(
-      user.id,
-      Number(req.query.id) as number
-    );
+    const deleted = await deleteCollectionById(user.id, collectionId);
     return res.status(deleted.status).json({ response: deleted.response });
   }
 }

pages/collections/[id].tsx

@@ -24,6 +24,8 @@ import CardView from "@/components/LinkViews/Layouts/CardView";
 // import GridView from "@/components/LinkViews/Layouts/GridView";
 import ListView from "@/components/LinkViews/Layouts/ListView";
 import { dropdownTriggerer } from "@/lib/client/utils";
+import Link from "next/link";
+import NewCollectionModal from "@/components/ModalContent/NewCollectionModal";
 
 export default function Index() {
   const { settings } = useLocalSettingsStore();
@@ -82,6 +84,7 @@ export default function Index() {
   }, [activeCollection]);
 
   const [editCollectionModal, setEditCollectionModal] = useState(false);
+  const [newCollectionModal, setNewCollectionModal] = useState(false);
   const [editCollectionSharingModal, setEditCollectionSharingModal] =
     useState(false);
   const [deleteCollectionModal, setDeleteCollectionModal] = useState(false);
@@ -160,6 +163,20 @@ export default function Index() {
                       : "View Team"}
                   </div>
                 </li>
+                {permissions === true ? (
+                  <li>
+                    <div
+                      role="button"
+                      tabIndex={0}
+                      onClick={() => {
+                        (document?.activeElement as HTMLElement)?.blur();
+                        setNewCollectionModal(true);
+                      }}
+                    >
+                      Create Sub-Collection
+                    </div>
+                  </li>
+                ) : undefined}
                 <li>
                   <div
                     role="button"
@@ -228,6 +245,31 @@ export default function Index() {
           <p>{activeCollection?.description}</p>
         ) : undefined}
 
+        {/* {collections.some((e) => e.parentId === activeCollection.id) ? (
+          <fieldset className="border rounded-md p-2 border-neutral-content">
+            <legend className="text-sm ml-2">Sub-Collections</legend>
+            <div className="flex gap-3">
+              {collections
+                .filter((e) => e.parentId === activeCollection?.id)
+                .map((e, i) => {
+                  return (
+                    <Link
+                      key={i}
+                      className="flex gap-1 items-center btn btn-ghost btn-sm"
+                      href={`/collections/${e.id}`}
+                    >
+                      <i
+                        className="bi-folder-fill text-2xl drop-shadow"
+                        style={{ color: e.color }}
+                      ></i>
+                      <p className="text-xs">{e.name}</p>
+                    </Link>
+                  );
+                })}
+            </div>
+          </fieldset>
+        ) : undefined} */}
+
         <div className="divider my-0"></div>
 
         <div className="flex justify-between items-end gap-5">
@@ -262,6 +304,12 @@ export default function Index() {
               activeCollection={activeCollection}
             />
           ) : undefined}
+          {newCollectionModal ? (
+            <NewCollectionModal
+              onClose={() => setNewCollectionModal(false)}
+              parent={activeCollection}
+            />
+          ) : undefined}
           {deleteCollectionModal ? (
             <DeleteCollectionModal
               onClose={() => setDeleteCollectionModal(false)}

pages/collections/index.tsx

@@ -39,7 +39,7 @@ export default function Collections() {
 
         <div className="grid min-[1900px]:grid-cols-4 2xl:grid-cols-3 sm:grid-cols-2 grid-cols-1 gap-5">
           {sortedCollections
-            .filter((e) => e.ownerId === data?.user.id)
+            .filter((e) => e.ownerId === data?.user.id && e.parentId === null)
             .map((e, i) => {
               return <CollectionCard key={i} collection={e} />;
             })}

pages/settings/access-tokens.tsx

@@ -38,7 +38,7 @@ export default function AccessTokens() {
         </p>
 
         <button
-          className={`btn btn-accent dark:border-violet-400 text-white tracking-wider w-fit flex items-center gap-2`}
+          className={`btn ml-auto btn-accent dark:border-violet-400 text-white tracking-wider w-fit flex items-center gap-2`}
           onClick={() => {
             setNewTokenModal(true);
           }}
@@ -48,7 +48,7 @@ export default function AccessTokens() {
 
         {tokens.length > 0 ? (
           <>
-            <div className="divider"></div>
+            <div className="divider my-0"></div>
 
             <table className="table">
               {/* head */}

prisma/migrations/20240125124457_added_subcollection_relations/migration.sql

@@ -0,0 +1,5 @@
+-- AlterTable
+ALTER TABLE "Collection" ADD COLUMN     "parentId" INTEGER;
+
+-- AddForeignKey
+ALTER TABLE "Collection" ADD CONSTRAINT "Collection_parentId_fkey" FOREIGN KEY ("parentId") REFERENCES "Collection"("id") ON DELETE SET NULL ON UPDATE CASCADE;

prisma/schema.prisma

@@ -69,17 +69,20 @@ model VerificationToken {
 }
 
 model Collection {
-  id          Int                   @id @default(autoincrement())
-  name        String
-  description String                @default("")
-  color       String                @default("#0ea5e9")
-  isPublic    Boolean               @default(false)
-  owner       User                  @relation(fields: [ownerId], references: [id])
-  ownerId     Int
-  members     UsersAndCollections[]
-  links       Link[]
-  createdAt   DateTime              @default(now())
-  updatedAt   DateTime              @default(now()) @updatedAt
+  id              Int                   @id @default(autoincrement())
+  name            String
+  description     String                @default("")
+  color           String                @default("#0ea5e9")
+  parentId        Int?
+  parent          Collection?           @relation("SubCollections", fields: [parentId], references: [id])
+  subCollections  Collection[]          @relation("SubCollections")
+  isPublic        Boolean               @default(false)
+  owner           User                  @relation(fields: [ownerId], references: [id])
+  ownerId         Int
+  members         UsersAndCollections[]
+  links           Link[]
+  createdAt       DateTime              @default(now())
+  updatedAt       DateTime              @default(now()) @updatedAt
 
   @@unique([name, ownerId])
 }

scripts/worker.ts

@@ -1,4 +1,4 @@
-import 'dotenv/config';
+import "dotenv/config";
 import { Collection, Link, User } from "@prisma/client";
 import { prisma } from "../lib/api/db";
 import archiveHandler from "../lib/api/archiveHandler";

store/collections.ts

@@ -78,7 +78,11 @@ const useCollectionStore = create<CollectionStore>()((set) => ({
 
     if (response.ok) {
       set((state) => ({
-        collections: state.collections.filter((e) => e.id !== collectionId),
+        collections: state.collections.filter(
+          (collection) =>
+            collection.id !== collectionId &&
+            collection.parentId !== collectionId
+        ),
       }));
       useTagStore.getState().setTags();
     }