brilliance-admin 0.44.10__tar.gz → 0.44.12__tar.gz

{brilliance_admin-0.44.10 → brilliance_admin-0.44.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: brilliance-admin
-Version: 0.44.10
+Version: 0.44.12
 Summary: Simple and lightweight data managment framework powered by FastAPI and Vue3 Vuetify all-in-one. Some call it heavenly in its brilliance.
 License-Expression: MIT
 Requires-Python: >=3.10

{brilliance_admin-0.44.10 → brilliance_admin-0.44.12}/brilliance_admin/api/routers.py

@@ -4,7 +4,7 @@ from .views.schema import router as schema_router
 from .views.table import router as schema_table
 from .views.auth import router as schema_auth
 from .views.autocomplete import router as schema_autocomplete
-from .views.graphs import router as schema_graphs
+from .views.dashboard import router as schema_dashboard
 from .views.settings import router as schema_settings
 from .views.index import router as schema_index
 
@@ -13,6 +13,6 @@ brilliance_admin_router.include_router(schema_router)
 brilliance_admin_router.include_router(schema_table)
 brilliance_admin_router.include_router(schema_auth)
 brilliance_admin_router.include_router(schema_autocomplete)
-brilliance_admin_router.include_router(schema_graphs)
+brilliance_admin_router.include_router(schema_dashboard)
 brilliance_admin_router.include_router(schema_settings)
 brilliance_admin_router.include_router(schema_index)

brilliance_admin-0.44.10/brilliance_admin/api/views/graphs.py → brilliance_admin-0.44.12/brilliance_admin/api/views/dashboard.py

@@ -4,21 +4,21 @@ from fastapi.responses import JSONResponse
 from brilliance_admin.api.utils import get_category
 from brilliance_admin.exceptions import AdminAPIException
 from brilliance_admin.schema.admin_schema import AdminSchema
-from brilliance_admin.schema.graphs.category_graphs import CategoryGraphs, GraphData, GraphsDataResult
+from brilliance_admin.schema.dashboard.category_dashboard import CategoryDashboard, DashboardData, DashboardContainer
 from brilliance_admin.translations import LanguageContext
 from brilliance_admin.utils import get_logger
 
-router = APIRouter(prefix="/graph", tags=["Category - Graph"])
+router = APIRouter(prefix="/dashboard", tags=["Category - Dashboard"])
 
 logger = get_logger()
 
 
 @router.post(path='/{group}/{category}/')
-async def graph_data(request: Request, group: str, category: str, data: GraphData) -> GraphsDataResult:
+async def dashboard_data(request: Request, group: str, category: str, data: DashboardData) -> DashboardContainer:
     schema: AdminSchema = request.app.state.schema
-    schema_category, user = await get_category(request, group, category, check_type=CategoryGraphs)
+    schema_category, user = await get_category(request, group, category, check_type=CategoryDashboard)
 
-    result: GraphsDataResult = await schema_category.get_data(data, user)
+    result: DashboardContainer = await schema_category.get_data(data, user)
 
     language_slug = request.headers.get('Accept-Language')
     language_context: LanguageContext = schema.get_language_context(language_slug)

{brilliance_admin-0.44.10 → brilliance_admin-0.44.12}/brilliance_admin/schema/__init__.py

@@ -2,6 +2,6 @@
 # flake8: noqa: F405
 from .admin_schema import AdminSchema, AdminSchemaData
 from .category import CategoryGroup, CategoryLink
-from .graphs import *
+from .dashboard import *
 from .table import *
 from .table.category_table import CategoryTable

{brilliance_admin-0.44.10 → brilliance_admin-0.44.12}/brilliance_admin/schema/admin_schema.py

@@ -40,6 +40,7 @@ class AdminSettingsData(DataclassBase):
     login_greetings_message: SupportsStr | None
     navbar_density: str
     languages: Dict[str, str] | None
+    main_page: str | None = None
 
 
 @dataclass
@@ -54,6 +55,8 @@ class AdminSchema:
     categories: List[BaseCategory]
     auth: Any
 
+    main_page: str | None = None
+
     title: SupportsStr | None = 'Admin'
     description: SupportsStr | None = None
     login_greetings_message: SupportsStr | None = None
@@ -118,6 +121,7 @@ class AdminSchema:
 
         return AdminSettingsData(
             title=self.title,
+            main_page=self.main_page,
             description=self.description,
             login_greetings_message=self.login_greetings_message,
             navbar_density=self.navbar_density,

{brilliance_admin-0.44.10 → brilliance_admin-0.44.12}/brilliance_admin/schema/category.py

@@ -95,7 +95,7 @@ class TableInfoSchemaData(DataclassBase):
 
 
 @dataclass
-class GraphInfoSchemaData(DataclassBase):
+class DashboardInfoSchemaData(DataclassBase):
     search_enabled: bool
     search_help: str | None
 
@@ -112,7 +112,7 @@ class CategorySchemaData(DataclassBase):
     categories: dict = Field(default_factory=dict)
 
     table_info: TableInfoSchemaData | None = None
-    graph_info: GraphInfoSchemaData | None = None
+    dashboard_info: DashboardInfoSchemaData | None = None
 
     link: str | None = None
 

brilliance_admin-0.44.12/brilliance_admin/schema/dashboard/__init__.py

@@ -0,0 +1 @@
+from .category_dashboard import CategoryDashboard

brilliance_admin-0.44.12/brilliance_admin/schema/dashboard/category_dashboard.py

@@ -0,0 +1,87 @@
+from typing import Any, Dict, List
+
+from pydantic import BaseModel, Field, field_serializer
+
+from brilliance_admin.schema.category import BaseCategory, DashboardInfoSchemaData
+from brilliance_admin.schema.table.fields_schema import FieldsSchema
+from brilliance_admin.translations import LanguageContext
+from brilliance_admin.utils import SupportsStr
+
+
+class DashboardData(BaseModel):
+    search: str | None = None
+    filters: Dict[str, Any] = Field(default_factory=dict)
+
+
+class ChartData(BaseModel):
+    data: dict
+    options: dict
+    width: int | None = None
+    height: int = 50
+    type: str = 'line'
+
+    component_type: str = 'chart'
+
+
+class Subcard(BaseModel):
+    title: SupportsStr
+    value: SupportsStr
+    color: str | None = None
+
+
+class PeriodGraph(BaseModel):
+    title: SupportsStr
+    value: SupportsStr
+    change: int | float | None = None
+    subcards: List[Subcard] = Field(default_factory=list)
+    values: List[List[int | float]] = Field(default_factory=list)
+    vertical: List[SupportsStr] = Field(default_factory=list)
+    horizontal: List[SupportsStr] = Field(default_factory=list)
+    component_type: str = 'period_graph'
+
+    @field_serializer('horizontal', 'vertical')
+    def serialize_str_list(self, val: list) -> list:
+        return [str(v) for v in val]
+
+
+class SmallGraph(BaseModel):
+    title: SupportsStr
+    value: SupportsStr
+    change: int | float | None = None
+    points: Dict[SupportsStr, float | int] = Field(default_factory=list)
+    component_type: str = 'small_graph'
+
+
+class DashboardContainer(BaseModel):
+    cols: int | None = None
+    md: int | None = None
+    lg: int | None = None
+    sm: int | None = None
+
+    component_type: str = 'container'
+    components: List[Any] = Field(default_factory=list)
+
+
+class CategoryDashboard(BaseCategory):
+    _type_slug: str = 'dashboard'
+
+    search_enabled: bool = False
+    search_help: SupportsStr | None = None
+
+    table_filters: FieldsSchema | None = None
+
+    def generate_schema(self, user, language_context: LanguageContext) -> DashboardInfoSchemaData:
+        schema = super().generate_schema(user, language_context)
+        dashboard_info = DashboardInfoSchemaData(
+            search_enabled=self.search_enabled,
+            search_help=language_context.get_text(self.search_help),
+        )
+
+        if self.table_filters:
+            dashboard_info.table_filters = self.table_filters.generate_schema(user, language_context)
+
+        schema.dashboard_info = dashboard_info
+        return schema
+
+    async def get_data(self, data: DashboardData, user) -> DashboardContainer:
+        raise NotImplementedError('get_data is not implemented')