[WEB-1907] feat: Favorites Enhancements

apiserver/plane/app/serializers/__init__.py

@@ -121,3 +121,5 @@
 from .webhook import WebhookSerializer, WebhookLogSerializer
 
 from .dashboard import DashboardSerializer, WidgetSerializer
+
+from .favorite import UserFavoriteSerializer

apiserver/plane/app/serializers/favorite.py

@@ -0,0 +1,101 @@
+from rest_framework import serializers
+
+from plane.db.models import (
+    UserFavorite,
+    Cycle,
+    Module,
+    Issue,
+    IssueView,
+    Page,
+    Project,
+)
+
+
+class ProjectFavoriteLiteSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = Project
+        fields = ["id", "name", "logo_props"]
+
+
+class PageFavoriteLiteSerializer(serializers.ModelSerializer):
+    project_id = serializers.SerializerMethodField()
+
+    class Meta:
+        model = Page
+        fields = ["id", "name", "logo_props", "project_id"]
+
+    def get_project_id(self, obj):
+        project = (
+            obj.projects.first()
+        )  # This gets the first project related to the Page
+        return project.id if project else None
+
+
+class CycleFavoriteLiteSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = Cycle
+        fields = ["id", "name", "logo_props", "project_id"]
+
+
+class ModuleFavoriteLiteSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = Module
+        fields = ["id", "name", "logo_props", "project_id"]
+
+
+class ViewFavoriteSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = IssueView
+        fields = ["id", "name", "logo_props", "project_id"]
+
+
+def get_entity_model_and_serializer(entity_type):
+    entity_map = {
+        "cycle": (Cycle, CycleFavoriteLiteSerializer),
+        "issue": (Issue, None),
+        "module": (Module, ModuleFavoriteLiteSerializer),
+        "view": (IssueView, ViewFavoriteSerializer),
+        "page": (Page, PageFavoriteLiteSerializer),
+        "project": (Project, ProjectFavoriteLiteSerializer),
+        "folder": (None, None),
+    }
+    return entity_map.get(entity_type, (None, None))
+
+
+class UserFavoriteSerializer(serializers.ModelSerializer):
+    entity_data = serializers.SerializerMethodField()
+
+    class Meta:
+        model = UserFavorite
+        fields = [
+            "id",
+            "entity_type",
+            "entity_identifier",
+            "entity_data",
+            "name",
+            "is_folder",
+            "sequence",
+            "parent",
+            "workspace_id",
+            "project_id",
+        ]
+        read_only_fields = ["workspace", "created_by", "updated_by"]
+
+    def get_entity_data(self, obj):
+        entity_type = obj.entity_type
+        entity_identifier = obj.entity_identifier
+
+        entity_model, entity_serializer = get_entity_model_and_serializer(
+            entity_type
+        )
+        if entity_model and entity_serializer:
+            try:
+                entity = entity_model.objects.get(pk=entity_identifier)
+                return entity_serializer(entity).data
+            except entity_model.DoesNotExist:
+                return None
+        return None

apiserver/plane/app/urls/workspace.py

@@ -25,6 +25,8 @@
     ExportWorkspaceUserActivityEndpoint,
     WorkspaceModulesEndpoint,
     WorkspaceCyclesEndpoint,
+    WorkspaceFavoriteEndpoint,
+    WorkspaceFavoriteGroupEndpoint,
 )
 
 
@@ -237,4 +239,19 @@
         WorkspaceCyclesEndpoint.as_view(),
         name="workspace-cycles",
     ),
+    path(
+        "workspaces/<str:slug>/user-favorites/",
+        WorkspaceFavoriteEndpoint.as_view(),
+        name="workspace-user-favorites",
+    ),
+    path(
+        "workspaces/<str:slug>/user-favorites/<uuid:favorite_id>/",
+        WorkspaceFavoriteEndpoint.as_view(),
+        name="workspace-user-favorites",
+    ),
+    path(
+        "workspaces/<str:slug>/user-favorites/<uuid:favorite_id>/group/",
+        WorkspaceFavoriteGroupEndpoint.as_view(),
+        name="workspace-user-favorites-groups",
+    ),
 ]

apiserver/plane/app/views/__init__.py

@@ -40,6 +40,11 @@
     ExportWorkspaceUserActivityEndpoint,
 )
 
+from .workspace.favorite import (
+    WorkspaceFavoriteEndpoint,
+    WorkspaceFavoriteGroupEndpoint,
+)
+
 from .workspace.member import (
     WorkSpaceMemberViewSet,
     TeamMemberViewSet,

apiserver/plane/app/views/cycle/base.py

@@ -1154,7 +1154,7 @@ def destroy(self, request, slug, project_id, cycle_id):
             workspace__slug=slug,
             entity_identifier=cycle_id,
         )
-        cycle_favorite.delete()
+        cycle_favorite.delete(soft=False)
         return Response(status=status.HTTP_204_NO_CONTENT)
 
 

apiserver/plane/app/views/module/base.py

@@ -840,7 +840,7 @@ def destroy(self, request, slug, project_id, module_id):
             entity_type="module",
             entity_identifier=module_id,
         )
-        module_favorite.delete()
+        module_favorite.delete(soft=False)
         return Response(status=status.HTTP_204_NO_CONTENT)
 
 

apiserver/plane/app/views/page/base.py

@@ -401,7 +401,7 @@ def destroy(self, request, slug, project_id, pk):
             entity_identifier=pk,
             entity_type="page",
         )
-        page_favorite.delete()
+        page_favorite.delete(soft=False)
         return Response(status=status.HTTP_204_NO_CONTENT)
 
 

apiserver/plane/app/views/project/base.py

@@ -599,7 +599,7 @@ def destroy(self, request, slug, project_id):
             user=request.user,
             workspace__slug=slug,
         )
-        project_favorite.delete()
+        project_favorite.delete(soft=False)
         return Response(status=status.HTTP_204_NO_CONTENT)
 
 

apiserver/plane/app/views/view/base.py

@@ -474,5 +474,5 @@ def destroy(self, request, slug, project_id, view_id):
             entity_type="view",
             entity_identifier=view_id,
         )
-        view_favorite.delete()
+        view_favorite.delete(soft=False)
         return Response(status=status.HTTP_204_NO_CONTENT)

apiserver/plane/app/views/workspace/favorite.py

@@ -0,0 +1,88 @@
+# Third party modules
+from rest_framework import status
+from rest_framework.response import Response
+
+# Django modules
+from django.db.models import Q
+
+# Module imports
+from plane.app.views.base import BaseAPIView
+from plane.db.models import UserFavorite, Workspace
+from plane.app.serializers import UserFavoriteSerializer
+from plane.app.permissions import WorkspaceEntityPermission
+
+
+class WorkspaceFavoriteEndpoint(BaseAPIView):
+    permission_classes = [
+        WorkspaceEntityPermission,
+    ]
+
+    def get(self, request, slug):
+        # the second filter is to check if the user is a member of the project
+        favorites = UserFavorite.objects.filter(
+            user=request.user,
+            workspace__slug=slug,
+            parent__isnull=True,
+        ).filter(
+            Q(project__isnull=True)
+            | (
+                Q(project__isnull=False)
+                & Q(project__project_projectmember__member=request.user)
+                & Q(project__project_projectmember__is_active=True)
+            )
+        )
+        serializer = UserFavoriteSerializer(favorites, many=True)
+        return Response(serializer.data, status=status.HTTP_200_OK)
+
+    def post(self, request, slug):
+        workspace = Workspace.objects.get(slug=slug)
+        serializer = UserFavoriteSerializer(data=request.data)
+        if serializer.is_valid():
+            serializer.save(
+                user_id=request.user.id,
+                workspace=workspace,
+                project_id=request.data.get("project_id", None),
+            )
+            return Response(serializer.data, status=status.HTTP_200_OK)
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+
+    def patch(self, request, slug, favorite_id):
+        favorite = UserFavorite.objects.get(
+            user=request.user, workspace__slug=slug, pk=favorite_id
+        )
+        serializer = UserFavoriteSerializer(
+            favorite, data=request.data, partial=True
+        )
+        if serializer.is_valid():
+            serializer.save()
+            return Response(serializer.data, status=status.HTTP_200_OK)
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+
+    def delete(self, request, slug, favorite_id):
+        favorite = UserFavorite.objects.get(
+            user=request.user, workspace__slug=slug, pk=favorite_id
+        )
+        favorite.delete(soft=False)
+        return Response(status=status.HTTP_204_NO_CONTENT)
+
+
+class WorkspaceFavoriteGroupEndpoint(BaseAPIView):
+    permission_classes = [
+        WorkspaceEntityPermission,
+    ]
+
+    def get(self, request, slug, favorite_id):
+        favorites = UserFavorite.objects.filter(
+            user=request.user,
+            workspace__slug=slug,
+            parent_id=favorite_id,
+        ).filter(
+            Q(project__isnull=True)
+            | (
+                Q(project__isnull=False)
+                & Q(project__project_projectmember__member=request.user)
+                & Q(project__project_projectmember__is_active=True)
+            )
+        )
+        serializer = UserFavoriteSerializer(favorites, many=True)
+        return Response(serializer.data, status=status.HTTP_200_OK)

apiserver/plane/db/models/favorite.py

@@ -39,9 +39,14 @@ class Meta:
 
     def save(self, *args, **kwargs):
         if self._state.adding:
-            largest_sequence = UserFavorite.objects.filter(
-                workspace=self.project.workspace
-            ).aggregate(largest=models.Max("sequence"))["largest"]
+            if self.project:
+                largest_sequence = UserFavorite.objects.filter(
+                    workspace=self.project.workspace
+                ).aggregate(largest=models.Max("sequence"))["largest"]
+            else:
+                largest_sequence = UserFavorite.objects.filter(
+                    workspace=self.workspace,
+                ).aggregate(largest=models.Max("sequence"))["largest"]
             if largest_sequence is not None:
                 self.sequence = largest_sequence + 10000
 

packages/types/src/favorite/favorite.d.ts

@@ -0,0 +1,14 @@
+export type IFavorite = {
+	id: string;
+	name: string;
+	entity_type: string;
+	entity_data: {
+		name: string;
+	};
+	is_folder: boolean;
+	sort_order: number;
+	parent: string | null;
+	entity_identifier?: string | null;
+	children: IFavorite[];
+	project_id: string | null;
+};

packages/types/src/favorite/index.d.ts

@@ -0,0 +1 @@
+export * from "./favorite";

packages/types/src/index.d.ts

@@ -28,3 +28,4 @@ export * from "./common";
 export * from "./pragmatic";
 export * from "./publish";
 export * from "./workspace-notifications";
+export * from "./favorite";

packages/ui/src/icons/favorite-folder-icon.tsx

@@ -0,0 +1,32 @@
+import * as React from "react";
+
+import { ISvgIcons } from "./type";
+
+export const FavoriteFolderIcon: React.FC<ISvgIcons> = ({ className = "text-current", color = "#a3a3a3", ...rest }) => (
+  <svg
+    width="16"
+    height="16"
+    viewBox="0 0 16 16"
+    fill="none"
+    xmlns="http://www.w3.org/2000/svg"
+    stroke={color}
+    className={`${className} stroke-2`}
+    {...rest}
+  >
+    <path
+      d="M7.33325 13.3334H2.66659C2.31296 13.3334 1.97382 13.1929 1.72378 12.9429C1.47373 12.6928 1.33325 12.3537 1.33325 12.0001V3.3334C1.33325 2.97978 1.47373 2.64064 1.72378 2.39059C1.97382 2.14054 2.31296 2.00006 2.66659 2.00006H5.26659C5.48958 1.99788 5.70955 2.05166 5.90638 2.15648C6.10322 2.2613 6.27061 2.41381 6.39325 2.60006L6.93325 3.40006C7.05466 3.58442 7.21994 3.73574 7.41425 3.84047C7.60857 3.94519 7.82585 4.00003 8.04658 4.00006H13.3333C13.6869 4.00006 14.026 4.14054 14.2761 4.39059C14.5261 4.64064 14.6666 4.97978 14.6666 5.3334V6.3334"
+      // stroke="#60646C"
+      stroke-width="1.25"
+      stroke-linecap="round"
+      stroke-linejoin="round"
+    />
+    <path
+      d="M12.1373 8L13.0038 9.75535L14.9414 10.0386L13.5394 11.4041L13.8702 13.3333L12.1373 12.422L10.4044 13.3333L10.7353 11.4041L9.33325 10.0386L11.2709 9.75535L12.1373 8Z"
+      stroke-width="1.25"
+      // stroke="#60646C"
+      stroke-linecap="round"
+      stroke-linejoin="round"
+      fill="none"
+    />
+  </svg>
+);

packages/ui/src/icons/index.ts

@@ -24,3 +24,4 @@ export * from "./info-icon";
 export * from "./dropdown-icon";
 export * from "./intake";
 export * from "./user-activity-icon";
+export * from "./favorite-folder-icon";

web/app/[workspaceSlug]/(projects)/sidebar.tsx

@@ -10,6 +10,7 @@ import {
   SidebarWorkspaceMenu,
 } from "@/components/workspace";
 // helpers
+import { SidebarFavoritesMenu } from "@/components/workspace/sidebar/favorites/favorites-menu";
 import { cn } from "@/helpers/common.helper";
 // hooks
 import { useAppTheme } from "@/hooks/store";
@@ -41,7 +42,6 @@ export const AppSidebar: FC<IAppSidebar> = observer(() => {
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [windowSize]);
 
-
   return (
     <div
       className={cn(
@@ -78,6 +78,12 @@ export const AppSidebar: FC<IAppSidebar> = observer(() => {
             "opacity-0": !sidebarCollapsed,
           })}
         />
+        <SidebarFavoritesMenu />
+        <hr
+          className={cn("flex-shrink-0 border-custom-sidebar-border-300 h-[0.5px] w-3/5 mx-auto my-1", {
+            "opacity-0": !sidebarCollapsed,
+          })}
+        />
         <SidebarProjectsList />
         <SidebarHelpSection />
       </div>