Merge pull request #768 from makeplane/feat/workspace_themes

feat: workspace themes

apiserver/plane/api/serializers/__init__.py

@@ -11,6 +11,7 @@ from .workspace import (
     TeamSerializer,
     WorkSpaceMemberInviteSerializer,
     WorkspaceLiteSerializer,
+    WorkspaceThemeSerializer,
 )
 from .project import (
     ProjectSerializer,

apiserver/plane/api/serializers/workspace.py

@@ -5,8 +5,15 @@ from rest_framework import serializers
 from .base import BaseSerializer
 from .user import UserLiteSerializer
 
-from plane.db.models import User, Workspace, WorkspaceMember, Team, TeamMember
-from plane.db.models import Workspace, WorkspaceMember, Team, WorkspaceMemberInvite
+from plane.db.models import (
+    User,
+    Workspace,
+    WorkspaceMember,
+    Team,
+    TeamMember,
+    WorkspaceMemberInvite,
+    WorkspaceTheme,
+)
 
 
 class WorkSpaceSerializer(BaseSerializer):
@@ -100,3 +107,13 @@ class WorkspaceLiteSerializer(BaseSerializer):
             "id",
         ]
         read_only_fields = fields
+
+
+class WorkspaceThemeSerializer(BaseSerializer):
+    class Meta:
+        model = WorkspaceTheme
+        fields = "__all__"
+        read_only_fields = [
+            "workspace",
+            "actor",
+        ]

apiserver/plane/api/urls.py

@@ -42,6 +42,7 @@ from plane.api.views import (
     UserActivityGraphEndpoint,
     UserIssueCompletedGraphEndpoint,
     UserWorkspaceDashboardEndpoint,
+    WorkspaceThemeViewSet,
     ## End Workspaces
     # File Assets
     FileAssetEndpoint,
@@ -350,6 +351,27 @@ urlpatterns = [
         WorkspaceMemberUserViewsEndpoint.as_view(),
         name="workspace-member-details",
     ),
+    path(
+        "workspaces/<str:slug>/workspace-themes/",
+        WorkspaceThemeViewSet.as_view(
+            {
+                "get": "list",
+                "post": "create",
+            }
+        ),
+        name="workspace-themes",
+    ),
+    path(
+        "workspaces/<str:slug>/workspace-themes/<uuid:pk>/",
+        WorkspaceThemeViewSet.as_view(
+            {
+                "get": "retrieve",
+                "patch": "partial_update",
+                "delete": "destroy",
+            }
+        ),
+        name="workspace-themes",
+    ),
     ## End Workspaces ##
     # Projects
     path(

apiserver/plane/api/views/__init__.py

@@ -40,6 +40,7 @@ from .workspace import (
     UserActivityGraphEndpoint,
     UserIssueCompletedGraphEndpoint,
     UserWorkspaceDashboardEndpoint,
+    WorkspaceThemeViewSet,
 )
 from .state import StateViewSet
 from .shortcut import ShortCutViewSet

apiserver/plane/api/views/workspace.py

@@ -36,6 +36,7 @@ from plane.api.serializers import (
     WorkSpaceMemberInviteSerializer,
     UserLiteSerializer,
     ProjectMemberSerializer,
+    WorkspaceThemeSerializer,
 )
 from plane.api.views.base import BaseAPIView
 from . import BaseViewSet
@@ -48,6 +49,7 @@ from plane.db.models import (
     ProjectMember,
     IssueActivity,
     Issue,
+    WorkspaceTheme,
 )
 from plane.api.permissions import WorkSpaceBasePermission, WorkSpaceAdminPermission
 from plane.bgtasks.workspace_invitation_task import workspace_invitation
@@ -752,3 +754,35 @@ class UserWorkspaceDashboardEndpoint(BaseAPIView):
                 {"error": "Something went wrong please try again later"},
                 status=status.HTTP_400_BAD_REQUEST,
             )
+
+
+class WorkspaceThemeViewSet(BaseViewSet):
+    permission_classes = [
+        WorkSpaceAdminPermission,
+    ]
+    model = WorkspaceTheme
+    serializer_class = WorkspaceThemeSerializer
+
+    def get_queryset(self):
+        return super().get_queryset().filter(workspace__slug=self.kwargs.get("slug"))
+
+    def create(self, request, slug):
+        try:
+            workspace = Workspace.objects.get(slug=slug)
+            serializer = WorkspaceThemeSerializer(data=request.data)
+            if serializer.is_valid():
+                serializer.save(workspace=workspace, actor=request.user)
+                return Response(serializer.data, status=status.HTTP_201_CREATED)
+            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+        except Workspace.DoesNotExist:
+            return Response(
+                {"error": "Workspace does not exist"},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+        except Exception as e:
+            print(e)
+            return Response(
+                {"error": "Something went wrong please try again later"},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+

apiserver/plane/db/models/__init__.py

@@ -8,6 +8,7 @@ from .workspace import (
     Team,
     WorkspaceMemberInvite,
     TeamMember,
+    WorkspaceTheme,
 )
 
 from .project import (

apiserver/plane/db/models/user.py

@@ -72,6 +72,7 @@ class User(AbstractBaseUser, PermissionsMixin):
     my_issues_prop = models.JSONField(null=True)
     role = models.CharField(max_length=300, null=True, blank=True)
     is_bot = models.BooleanField(default=False)
+    theme = models.JSONField(default=dict)
 
     USERNAME_FIELD = "email"
 

apiserver/plane/db/models/workspace.py

@@ -36,7 +36,6 @@ class Workspace(BaseModel):
         ordering = ("-created_at",)
 
 
-
 class WorkspaceMember(BaseModel):
     workspace = models.ForeignKey(
         "db.Workspace", on_delete=models.CASCADE, related_name="workspace_member"
@@ -111,7 +110,6 @@ class Team(BaseModel):
 
 
 class TeamMember(BaseModel):
-
     workspace = models.ForeignKey(
         Workspace, on_delete=models.CASCADE, related_name="team_member"
     )
@@ -129,3 +127,24 @@ class TeamMember(BaseModel):
         verbose_name_plural = "Team Members"
         db_table = "team_members"
         ordering = ("-created_at",)
+
+
+class WorkspaceTheme(BaseModel):
+    workspace = models.ForeignKey(
+        "db.Workspace", on_delete=models.CASCADE, related_name="themes"
+    )
+    name = models.CharField(max_length=300)
+    actor = models.ForeignKey(
+        settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="themes"
+    )
+    colors = models.JSONField(default=dict)
+
+    def __str__(self):
+        return str(self.name) + str(self.actor.email)
+
+    class Meta:
+        unique_together = ["workspace", "name"]
+        verbose_name = "Workspace Theme"
+        verbose_name_plural = "Workspace Themes"
+        db_table = "workspace_themes"
+        ordering = ("-created_at",)