domain to schema

Author: pcrespov

packages/models-library/src/models_library/api_schemas_webserver/projects.py

@@ -28,7 +28,6 @@
 from ..projects import ClassifierID, DateTimeStr, NodesDict, ProjectID
 from ..projects_access import AccessRights, GroupIDStr
 from ..projects_state import ProjectState
-from ..projects_ui import StudyUI
 from ..utils._original_fastapi_encoders import jsonable_encoder
 from ..utils.common_validators import (
     empty_str_to_none_pre_validator,
@@ -38,6 +37,7 @@
 from ..workspaces import WorkspaceID
 from ._base import EmptyModel, InputSchema, OutputSchema
 from .permalinks import ProjectPermalink
+from .projects_ui import StudyUI
 
 
 class ProjectCreateNew(InputSchema):

packages/models-library/src/models_library/api_schemas_webserver/projects_nodes_ui.py

@@ -0,0 +1,14 @@
+from typing import Annotated, TypeAlias
+
+from pydantic import BaseModel, ConfigDict, Field, PlainSerializer
+from pydantic_extra_types.color import Color
+
+from ..projects_nodes_layout import Position
+
+PositionUI: TypeAlias = Position
+
+
+class MarkerUI(BaseModel):
+    color: Annotated[Color, PlainSerializer(Color.as_hex), Field(...)]
+
+    model_config = ConfigDict(extra="forbid")

packages/models-library/src/models_library/projects_ui.py renamed to packages/models-library/src/models_library/api_schemas_webserver/projects_ui.py

@@ -18,9 +18,9 @@
     TypedDict,
 )
 
-from .projects_nodes_io import NodeID, NodeIDStr
+from ..projects_nodes_io import NodeID, NodeIDStr
+from ..utils.common_validators import empty_str_to_none_pre_validator
 from .projects_nodes_ui import MarkerUI, PositionUI
-from .utils.common_validators import empty_str_to_none_pre_validator
 
 
 class WorkbenchUI(BaseModel):

packages/models-library/src/models_library/projects.py

@@ -20,7 +20,6 @@
 from .projects_nodes import Node
 from .projects_nodes_io import NodeIDStr
 from .projects_state import ProjectState
-from .projects_ui import StudyUI
 from .users import UserID
 from .utils.common_validators import (
     empty_str_to_none_pre_validator,
@@ -117,6 +116,9 @@ def _convert_sql_alchemy_enum(cls, v):
     )
 
 
+StudyUIDict: TypeAlias = dict[str, Any]
+
+
 class Project(BaseProjectModel):
     # NOTE: This is the pydantic pendant of project-v0.0.1.json used in the API of the webserver/webclient
     # NOT for usage with DB!!
@@ -160,7 +162,7 @@ class Project(BaseProjectModel):
     state: ProjectState | None = None
 
     # UI front-end setup (SEE projects_ui.py)
-    ui: StudyUI | None = None
+    ui: StudyUIDict | None = None
 
     # Quality
     quality: dict[str, Any] = Field(

packages/models-library/src/models_library/projects_nodes.py

@@ -27,7 +27,7 @@
     PortLink,
     SimCoreFileLink,
 )
-from .projects_nodes_ui import PositionUI
+from .projects_nodes_layout import Position
 from .projects_state import RunningState
 from .services import ServiceKey, ServiceVersion
 
@@ -224,7 +224,7 @@ class Node(BaseModel):
     ] = None
 
     position: Annotated[
-        PositionUI | None,
+        Position | None,
         Field(
             deprecated=True,
             description="Use projects_ui.WorkbenchUI.position instead",

packages/models-library/src/models_library/projects_nodes_layout.py

@@ -0,0 +1,8 @@
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class Position(BaseModel):
+    x: int = Field(..., description="The x position", examples=[["12"]])
+    y: int = Field(..., description="The y position", examples=[["15"]])
+
+    model_config = ConfigDict(extra="forbid")

packages/models-library/src/models_library/projects_nodes_ui.py

@@ -1,5 +1,5 @@
 import pytest
-from models_library.projects_nodes_ui import MarkerUI
+from models_library.api_schemas_webserver.projects_nodes_ui import MarkerUI
 from pydantic_extra_types.color import Color
 
 

packages/models-library/tests/test_projects_nodes_ui.py

@@ -1,5 +1,5 @@
 import pytest
-from models_library.projects_ui import AnnotationUI
+from models_library.api_schemas_webserver.projects_ui import AnnotationUI
 from pydantic_extra_types.color import Color
 
 

packages/models-library/tests/test_projects_ui.py

@@ -3,20 +3,17 @@
 from models_library.projects_access import AccessRights
 from models_library.projects_nodes import InputTypes, Node, OutputTypes
 from models_library.projects_nodes_io import SimCoreFileLink
-from models_library.projects_ui import StudyUI
 
 assert AccessRights  # nosec
 assert InputTypes  # nosec
 assert Node  # nosec
 assert OutputTypes  # nosec
 assert SimCoreFileLink  # nosec
-assert StudyUI  # nosec
 
 __all__: tuple[str, ...] = (
     "AccessRights",
     "InputTypes",
     "Node",
     "OutputTypes",
     "SimCoreFileLink",
-    "StudyUI",
 )