feat: Auth model is market with a security icon (#19)

Author: mslaursen

fastapi_forge/dtos.py

@@ -145,22 +145,22 @@ def target(self) -> str:
         return snake_to_camel(self.target_model)
 
 
-class ModelGenerationMetadata(_Base):
-    """Metadata used for code generation."""
-
+class ModelMetadata(_Base):
     create_endpoints: bool = True
     create_tests: bool = True
     create_daos: bool = True
     create_dtos: bool = True
 
+    is_auth_model: bool = False
+
 
 class Model(_Base):
     """Represents a model with fields and relationships."""
 
     name: ModelName
     fields: list[ModelField]
     relationships: list[ModelRelationship] = []
-    metadata: ModelGenerationMetadata = ModelGenerationMetadata()
+    metadata: ModelMetadata = ModelMetadata()
 
     @computed_field
     @property
@@ -321,6 +321,10 @@ def _validate_models(self) -> Self:
                         f"'{relationship.target_model}', which does not exist.",
                     )
 
+        if sum(model.metadata.is_auth_model for model in self.models) > 1:
+            msg = "Only one model can be an auth user."
+            raise ValueError(msg)
+
         return self
 
     @model_validator(mode="after")

fastapi_forge/example-projects/game_zone.yaml

@@ -34,6 +34,7 @@ project:
       metadata:
         create_endpoints: false
         create_tests: false
+        is_auth_model: true
 
     - name: user_profile
       fields:

fastapi_forge/frontend/components/model_row.py

@@ -9,11 +9,13 @@ def __init__(
         self,
         model: Model,
         color: str | None = None,
+        icon: str | None = None,
     ):
         super().__init__(wrap=False)
         self.model = model
         self.is_selected_row = model == state.selected_model
         self.color = color
+        self.icon = icon
         self.is_editing = False
         self._build()
 
@@ -26,7 +28,12 @@ def _build(self) -> None:
             base_classes += " hover:bg-gray-100 dark:hover:bg-gray-800"
 
         with self.classes(base_classes):
-            self.name_label = ui.label(text=self.model.name).classes("self-center")
+            with ui.row().classes("flex-nowrap gap-2 min-w-fit"):
+                if self.icon:
+                    ui.icon(self.icon, color="green", size="20px").classes(
+                        "self-center"
+                    )
+                self.name_label = ui.label(text=self.model.name).classes("self-center")
             if self.color:
                 self.name_label.classes(add=self.color)
             self.name_input = (

fastapi_forge/frontend/panels/model_editor_panel.py

@@ -284,6 +284,8 @@ def _handle_modal_add_relation(
         self._refresh_relationship_table(state.selected_model.relationships)
 
     def refresh(self) -> None:
+        if state.selected_model is None:
+            return
         self._refresh_table(state.selected_model.fields)
         self._refresh_relationship_table(state.selected_model.relationships)
 

fastapi_forge/frontend/panels/model_panel.py

@@ -58,11 +58,14 @@ def _render_models(self) -> None:
 
         with self.model_list:
             for model in state.models:
-                ModelRow(
+                mr = ModelRow(
                     model,
                     color=(
                         SELECTED_MODEL_TEXT_COLOR
                         if model == state.selected_model
                         else None
                     ),
+                    icon="security" if model.metadata.is_auth_model else None,
                 )
+                if model.metadata.is_auth_model:
+                    mr.tooltip("This model is used for Auth.")

fastapi_forge/jinja.py

@@ -2,7 +2,13 @@
 
 from jinja2 import Environment
 
-from fastapi_forge.dtos import Model, ModelField, ModelFieldMetadata, ModelRelationship
+from fastapi_forge.dtos import (
+    Model,
+    ModelField,
+    ModelFieldMetadata,
+    ModelMetadata,
+    ModelRelationship,
+)
 from fastapi_forge.enums import FieldDataType
 from fastapi_forge.jinja_utils import generate_field, generate_relationship
 
@@ -444,6 +450,7 @@ def render_model_to_delete_test(model: Model) -> str:
     models = [
         Model(
             name="auth_user",
+            metadata=ModelMetadata(is_auth_model=True),
             fields=[
                 ModelField(
                     name="id",