feat: on_delete select option for relations (#29)

Author: mslaursen

fastapi_forge/data_type_registry.py

@@ -2,7 +2,7 @@
 
 from pydantic import BaseModel
 
-from fastapi_forge.enums import FieldDataType
+from fastapi_forge.enums import FieldDataTypeEnum
 
 
 class DataTypeInfo(BaseModel):
@@ -17,14 +17,14 @@ class DataTypeInfo(BaseModel):
 
 class DataTypeInfoRegistry:
     def __init__(self):
-        self._registry: dict[FieldDataType, DataTypeInfo] = {}
+        self._registry: dict[FieldDataTypeEnum, DataTypeInfo] = {}
 
-    def register(self, field_data_type: FieldDataType, data_type: DataTypeInfo):
+    def register(self, field_data_type: FieldDataTypeEnum, data_type: DataTypeInfo):
         if field_data_type in self._registry:
             raise ValueError(f"Data type '{field_data_type}' is already registered.")
         self._registry[field_data_type] = data_type
 
-    def get(self, field_data_type: FieldDataType) -> DataTypeInfo:
+    def get(self, field_data_type: FieldDataTypeEnum) -> DataTypeInfo:
         if field_data_type not in self._registry:
             raise ValueError(f"Data type '{field_data_type}' not found.")
         return self._registry[field_data_type]
@@ -38,7 +38,7 @@ def all(self) -> list[DataTypeInfo]:
 
 
 registry.register(
-    FieldDataType.STRING,
+    FieldDataTypeEnum.STRING,
     DataTypeInfo(
         sqlalchemy_type="String",
         sqlalchemy_prefix=True,
@@ -51,7 +51,7 @@ def all(self) -> list[DataTypeInfo]:
 
 
 registry.register(
-    FieldDataType.FLOAT,
+    FieldDataTypeEnum.FLOAT,
     DataTypeInfo(
         sqlalchemy_type="Float",
         sqlalchemy_prefix=True,
@@ -65,7 +65,7 @@ def all(self) -> list[DataTypeInfo]:
 )
 
 registry.register(
-    FieldDataType.BOOLEAN,
+    FieldDataTypeEnum.BOOLEAN,
     DataTypeInfo(
         sqlalchemy_type="Boolean",
         sqlalchemy_prefix=True,
@@ -77,7 +77,7 @@ def all(self) -> list[DataTypeInfo]:
 )
 
 registry.register(
-    FieldDataType.DATETIME,
+    FieldDataTypeEnum.DATETIME,
     DataTypeInfo(
         sqlalchemy_type="DateTime(timezone=True)",
         sqlalchemy_prefix=True,
@@ -90,7 +90,7 @@ def all(self) -> list[DataTypeInfo]:
 )
 
 registry.register(
-    FieldDataType.UUID,
+    FieldDataTypeEnum.UUID,
     DataTypeInfo(
         sqlalchemy_type="UUID(as_uuid=True)",
         sqlalchemy_prefix=True,
@@ -102,7 +102,7 @@ def all(self) -> list[DataTypeInfo]:
 )
 
 registry.register(
-    FieldDataType.JSONB,
+    FieldDataTypeEnum.JSONB,
     DataTypeInfo(
         sqlalchemy_type="JSONB",
         sqlalchemy_prefix=False,
@@ -114,7 +114,7 @@ def all(self) -> list[DataTypeInfo]:
 )
 
 registry.register(
-    FieldDataType.INTEGER,
+    FieldDataTypeEnum.INTEGER,
     DataTypeInfo(
         sqlalchemy_type="Integer",
         sqlalchemy_prefix=True,

fastapi_forge/dtos.py

@@ -10,7 +10,7 @@
 )
 
 from fastapi_forge.data_type_registry import DataTypeInfo, registry
-from fastapi_forge.enums import FieldDataType
+from fastapi_forge.enums import FieldDataTypeEnum, OnDeleteEnum
 from fastapi_forge.string_utils import camel_to_snake_hyphen, snake_to_camel
 
 BoundedStr = Annotated[str, Field(..., min_length=1, max_length=100)]
@@ -40,11 +40,12 @@ class ModelField(_Base):
     """Represents a field in a model with validation and computed properties."""
 
     name: FieldName
-    type: FieldDataType
+    type: FieldDataTypeEnum
     primary_key: bool = False
     nullable: bool = False
     unique: bool = False
     index: bool = False
+    on_delete: OnDeleteEnum = OnDeleteEnum.CASCADE
     default_value: str | None = None
     extra_kwargs: dict[str, Any] | None = None
     metadata: ModelFieldMetadata = ModelFieldMetadata()
@@ -73,13 +74,13 @@ def _validate(self) -> Self:
         metadata = self.metadata
         if (
             metadata.is_created_at_timestamp or metadata.is_updated_at_timestamp
-        ) and self.type != FieldDataType.DATETIME:
+        ) and self.type != FieldDataTypeEnum.DATETIME:
             msg = "Create/update timestamp fields must be of type DateTime."
             raise ValueError(
                 msg,
             )
 
-        if metadata.is_foreign_key and self.type != FieldDataType.UUID:
+        if metadata.is_foreign_key and self.type != FieldDataTypeEnum.UUID:
             msg = "Foreign Keys must be of type UUID."
             raise ValueError(msg)
 
@@ -99,6 +100,7 @@ class ModelRelationship(_Base):
     field_name: FieldName
     target_model: ModelName
     back_populates: BackPopulates | None = None
+    on_delete: OnDeleteEnum = OnDeleteEnum.CASCADE
 
     nullable: bool = False
     unique: bool = False
@@ -252,7 +254,7 @@ def get_preview(self) -> "Model":
             preview_model.fields.append(
                 ModelField(
                     name=relation.field_name,
-                    type=FieldDataType.UUID,
+                    type=FieldDataTypeEnum.UUID,
                     primary_key=False,
                     nullable=relation.nullable,
                     unique=relation.unique,

fastapi_forge/enums.py

@@ -2,7 +2,7 @@
 from functools import lru_cache
 
 
-class FieldDataType(StrEnum):
+class FieldDataTypeEnum(StrEnum):
     STRING = "String"
     INTEGER = "Integer"
     FLOAT = "Float"
@@ -44,11 +44,11 @@ def get_type_mappings(cls) -> dict[str, list[str]]:
         }
 
     @classmethod
-    def get_custom_types(cls) -> dict[str, "FieldDataType"]:
+    def get_custom_types(cls) -> dict[str, "FieldDataTypeEnum"]:
         return {}
 
     @classmethod
-    def from_db_type(cls, db_type: str) -> "FieldDataType":
+    def from_db_type(cls, db_type: str) -> "FieldDataTypeEnum":
         db_type = db_type.lower()
 
         custom_types = cls.get_custom_types()
@@ -65,7 +65,12 @@ def from_db_type(cls, db_type: str) -> "FieldDataType":
         )
 
 
-class HTTPMethod(StrEnum):
+class OnDeleteEnum(StrEnum):
+    CASCADE = "CASCADE"
+    SET_NULL = "SET NULL"
+
+
+class HTTPMethodEnum(StrEnum):
     GET = "get"
     GET_ID = "get_id"
     POST = "post"

fastapi_forge/frontend/constants.py

@@ -1,7 +1,7 @@
 from typing import Any
 
 from fastapi_forge.dtos import ModelField
-from fastapi_forge.enums import FieldDataType
+from fastapi_forge.enums import FieldDataTypeEnum
 
 SELECTED_MODEL_TEXT_COLOR = "text-black-500 dark:text-amber-300"
 
@@ -40,9 +40,9 @@
         "align": "left",
     },
     {
-        "name": "back_populates",
-        "label": "Back Populates",
-        "field": "back_populates",
+        "name": "on_delete",
+        "label": "On Delete",
+        "field": "on_delete",
         "align": "left",
     },
     {"name": "nullable", "label": "Nullable", "field": "nullable", "align": "center"},
@@ -54,12 +54,12 @@
 DEFAULT_AUTH_USER_FIELDS: list[ModelField] = [
     ModelField(
         name="email",
-        type=FieldDataType.STRING,
+        type=FieldDataTypeEnum.STRING,
         unique=True,
         index=True,
     ),
     ModelField(
         name="password",
-        type=FieldDataType.STRING,
+        type=FieldDataTypeEnum.STRING,
     ),
 ]

fastapi_forge/frontend/modals/field_modal.py

@@ -5,7 +5,7 @@
 from pydantic import ValidationError
 
 from fastapi_forge.dtos import ModelField, ModelFieldMetadata
-from fastapi_forge.enums import FieldDataType
+from fastapi_forge.enums import FieldDataTypeEnum
 from fastapi_forge.frontend.notifications import notify_validation_error
 from fastapi_forge.frontend.state import state
 from fastapi_forge.jinja_utils import generate_field
@@ -38,7 +38,7 @@ def _build(self) -> None:
                         "outlined dense"
                     )
                     self.field_type = ui.select(
-                        list(FieldDataType),
+                        list(FieldDataTypeEnum),
                         label="Field Type",
                         on_change=self._toggle_metadata_visibility,
                     ).props("outlined dense")
@@ -84,7 +84,7 @@ def _build(self) -> None:
                 self._build_action_buttons()
 
     def _toggle_metadata_visibility(self):
-        self.show_metadata = self.field_type.value == FieldDataType.DATETIME
+        self.show_metadata = self.field_type.value == FieldDataTypeEnum.DATETIME
 
     def _add_kwarg_row(self, key: str = "", value: str = "") -> None:
         with (
@@ -254,7 +254,7 @@ def _set_field(self, field: ModelField) -> None:
             self.default_value.value = field.default_value or ""
             self.created_at.value = field.metadata.is_created_at_timestamp
             self.updated_at.value = field.metadata.is_updated_at_timestamp
-            self.show_metadata = field.type == FieldDataType.DATETIME
+            self.show_metadata = field.type == FieldDataTypeEnum.DATETIME
             self.extra_kwargs = field.extra_kwargs.copy() if field.extra_kwargs else {}
             self.kwargs_container.clear()
 

fastapi_forge/frontend/modals/relation_modal.py

@@ -4,6 +4,7 @@
 from nicegui import ui
 
 from fastapi_forge.dtos import Model, ModelRelationship
+from fastapi_forge.enums import OnDeleteEnum
 
 
 class BaseRelationModal(ui.dialog, ABC):
@@ -27,6 +28,11 @@ def _build_common_ui(self) -> None:
                         label="Target Model",
                         options=[],
                     ).props("outlined dense")
+                    self.on_delete = ui.select(
+                        label="On Delete",
+                        options=list(OnDeleteEnum),
+                        value=OnDeleteEnum.CASCADE,
+                    ).props("outlined dense")
                     self.back_populates = ui.input(label="Back Populates").props(
                         "outlined dense"
                     )
@@ -47,6 +53,7 @@ def _reset(self) -> None:
         self.field_name.value = ""
         self.target_model.value = None
         self.back_populates.value = ""
+        self.on_delete.value = None
         self.nullable.value = False
         self.index.value = False
         self.unique.value = False
@@ -74,6 +81,7 @@ def _add_relation(self) -> None:
             nullable=self.nullable.value,
             index=self.index.value,
             unique=self.unique.value,
+            on_delete=self.on_delete.value,
         )
         self.close()
 
@@ -109,6 +117,7 @@ def _update_relation(self) -> None:
             nullable=self.nullable.value,
             index=self.index.value,
             unique=self.unique.value,
+            on_delete=self.on_delete.value,
         )
         self.close()
 
@@ -121,6 +130,7 @@ def _set_relation(self, relation: ModelRelationship) -> None:
             self.index.value = relation.index
             self.unique.value = relation.unique
             self.back_populates.value = relation.back_populates
+            self.on_delete.value = relation.on_delete
 
     def open(
         self,

fastapi_forge/frontend/panels/model_editor_panel.py

@@ -4,7 +4,7 @@
 from pydantic import ValidationError
 
 from fastapi_forge.dtos import Model, ModelField, ModelFieldMetadata, ModelRelationship
-from fastapi_forge.enums import FieldDataType
+from fastapi_forge.enums import FieldDataTypeEnum, OnDeleteEnum
 from fastapi_forge.frontend.constants import (
     DEFAULT_AUTH_USER_FIELDS,
     FIELD_COLUMNS,
@@ -312,6 +312,7 @@ def _handle_modal_add_relation(
         nullable: bool,
         index: bool,
         unique: bool,
+        on_delete: OnDeleteEnum,
         back_populates: str | None = None,
     ) -> None:
         if not state.selected_model:
@@ -337,6 +338,7 @@ def _handle_modal_add_relation(
                 nullable=nullable,
                 index=index,
                 unique=unique,
+                on_delete=on_delete,
             )
         except ValidationError as exc:
             notify_validation_error(exc)
@@ -406,7 +408,7 @@ def _add_field(
         try:
             field_input = ModelField(
                 name=name,
-                type=FieldDataType(type),
+                type=FieldDataTypeEnum(type),
                 primary_key=primary_key,
                 nullable=nullable,
                 unique=unique,
@@ -514,7 +516,7 @@ def _handle_update_field(
         try:
             field_input = ModelField(
                 name=name,
-                type=FieldDataType(type),
+                type=FieldDataTypeEnum(type),
                 primary_key=primary_key,
                 nullable=nullable,
                 unique=unique,
@@ -538,6 +540,7 @@ def _handle_update_relation(
         nullable: bool = False,
         index: bool = False,
         unique: bool = False,
+        on_delete: OnDeleteEnum = OnDeleteEnum.CASCADE,
         back_populates: str | None = None,
     ) -> None:
         if not state.selected_model or not state.selected_relation:
@@ -565,6 +568,7 @@ def _handle_update_relation(
                 nullable=nullable,
                 index=index,
                 unique=unique,
+                on_delete=on_delete,
             )
         except ValidationError as exc:
             notify_validation_error(exc)