feat: dashboard widgets

apiserver/plane/app/serializers/__init__.py

@@ -68,7 +68,6 @@
     IssueRelationSerializer,
     RelatedIssueSerializer,
     IssuePublicSerializer,
-    IssueRelationLiteSerializer,
 )
 
 from .module import (
@@ -120,3 +119,5 @@
 from .exporter import ExporterHistorySerializer
 
 from .webhook import WebhookSerializer, WebhookLogSerializer
+
+from .dashboard import DashboardSerializer, WidgetSerializer

apiserver/plane/app/serializers/base.py

@@ -59,6 +59,7 @@ def _filter_fields(self, fields):
                     LabelSerializer,
                     CycleIssueSerializer,
                     IssueFlatSerializer,
+                    IssueRelationSerializer,
                 )
 
                 # Expansion mapper
@@ -78,14 +79,10 @@ def _filter_fields(self, fields):
                     "labels": LabelSerializer,
                     "issue_cycle": CycleIssueSerializer,
                     "parent": IssueSerializer,
+                    "issue_relation": IssueRelationSerializer,
                 }
-
-                self.fields[field] = expansion[field](
-                    many=True
-                    if field
-                    in ["members", "assignees", "labels", "issue_cycle"]
-                    else False
-                )
+
+                self.fields[field] = expansion[field](many=True if field in ["members", "assignees", "labels", "issue_cycle", "issue_relation"] else False)            
 
         return self.fields
 
@@ -105,6 +102,7 @@ def to_representation(self, instance):
                         IssueSerializer,
                         LabelSerializer,
                         CycleIssueSerializer,
+                        IssueRelationSerializer,
                     )
 
                     # Expansion mapper
@@ -124,6 +122,7 @@ def to_representation(self, instance):
                         "labels": LabelSerializer,
                         "issue_cycle": CycleIssueSerializer,
                         "parent": IssueSerializer,
+                        "issue_relation": IssueRelationSerializer
                     }
                     # Check if field in expansion then expand the field
                     if expand in expansion:

apiserver/plane/app/serializers/dashboard.py

@@ -0,0 +1,26 @@
+# Module imports
+from .base import BaseSerializer
+from plane.db.models import Dashboard, Widget
+
+# Third party frameworks
+from rest_framework import serializers
+
+
+class DashboardSerializer(BaseSerializer):
+    class Meta:
+        model = Dashboard
+        fields = "__all__"
+
+
+class WidgetSerializer(BaseSerializer):
+    is_visible = serializers.BooleanField(read_only=True)
+    widget_filters = serializers.JSONField(read_only=True)
+
+    class Meta:
+        model = Widget
+        fields = [
+            "id",
+            "key",
+            "is_visible",
+            "widget_filters"
+        ]

apiserver/plane/app/serializers/issue.py

@@ -293,31 +293,19 @@ class Meta:
         ]
 
 
-class IssueRelationLiteSerializer(DynamicBaseSerializer):
-    project_id = serializers.PrimaryKeyRelatedField(read_only=True)
+class IssueRelationSerializer(BaseSerializer):
+    id = serializers.UUIDField(source="related_issue.id", read_only=True)
+    project_id = serializers.PrimaryKeyRelatedField(source="related_issue.project_id", read_only=True)
+    sequence_id = serializers.IntegerField(source="related_issue.sequence_id", read_only=True)
+    relation_type = serializers.CharField(read_only=True)
 
     class Meta:
-        model = Issue
+        model = IssueRelation
         fields = [
             "id",
             "project_id",
             "sequence_id",
-        ]
-        read_only_fields = [
-            "workspace",
-            "project",
-        ]
-
-
-class IssueRelationSerializer(BaseSerializer):
-    issue_detail = IssueRelationLiteSerializer(
-        read_only=True, source="related_issue"
-    )
-
-    class Meta:
-        model = IssueRelation
-        fields = [
-            "issue_detail",
+            "relation_type",
         ]
         read_only_fields = [
             "workspace",
@@ -326,12 +314,18 @@ class Meta:
 
 
 class RelatedIssueSerializer(BaseSerializer):
-    issue_detail = IssueRelationLiteSerializer(read_only=True, source="issue")
+    id = serializers.UUIDField(source="issue.id", read_only=True)
+    project_id = serializers.PrimaryKeyRelatedField(source="issue.project_id", read_only=True)
+    sequence_id = serializers.IntegerField(source="issue.sequence_id", read_only=True)
+    relation_type = serializers.CharField(read_only=True)
 
     class Meta:
         model = IssueRelation
         fields = [
-            "issue_detail",
+            "id",
+            "project_id",
+            "sequence_id",
+            "relation_type",
         ]
         read_only_fields = [
             "workspace",

apiserver/plane/app/urls/__init__.py

@@ -3,6 +3,7 @@
 from .authentication import urlpatterns as authentication_urls
 from .config import urlpatterns as configuration_urls
 from .cycle import urlpatterns as cycle_urls
+from .dashboard import urlpatterns as dashboard_urls
 from .estimate import urlpatterns as estimate_urls
 from .external import urlpatterns as external_urls
 from .importer import urlpatterns as importer_urls
@@ -28,6 +29,7 @@
     *authentication_urls,
     *configuration_urls,
     *cycle_urls,
+    *dashboard_urls,
     *estimate_urls,
     *external_urls,
     *importer_urls,

apiserver/plane/app/urls/dashboard.py

@@ -0,0 +1,23 @@
+from django.urls import path
+
+
+from plane.app.views import DashboardEndpoint, WidgetsEndpoint
+
+
+urlpatterns = [
+    path(
+        "workspaces/<str:slug>/dashboard/",
+        DashboardEndpoint.as_view(),
+        name="dashboard",
+    ),
+    path(
+        "workspaces/<str:slug>/dashboard/<uuid:dashboard_id>/",
+        DashboardEndpoint.as_view(),
+        name="dashboard",
+    ),
+    path(
+        "dashboard/<uuid:dashboard_id>/widgets/<uuid:widget_id>/",
+        WidgetsEndpoint.as_view(),
+        name="widgets",
+    ),
+]

apiserver/plane/app/views/__init__.py

@@ -177,3 +177,8 @@
     WebhookLogsEndpoint,
     WebhookSecretRegenerateEndpoint,
 )
+
+from .dashboard import (
+    DashboardEndpoint,
+    WidgetsEndpoint
+)