statezero 0.1.0b61__tar.gz → 0.1.0b62__tar.gz

{statezero-0.1.0b61 → statezero-0.1.0b62}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: statezero
-Version: 0.1.0b61
+Version: 0.1.0b62
 Summary: Connect your Python backend to a modern JavaScript SPA frontend with 90% less complexity.
 Author-email: Robert <robert.herring@statezero.dev>
 Project-URL: homepage, https://www.statezero.dev

{statezero-0.1.0b61 → statezero-0.1.0b62}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "statezero"
-version = "0.1.0b61"
+version = "0.1.0b62"
 description = "Connect your Python backend to a modern JavaScript SPA frontend with 90% less complexity."
 readme = "README.md"
 license = { file = "LICENSE" }

{statezero-0.1.0b61 → statezero-0.1.0b62}/statezero/core/classes.py

@@ -1,10 +1,11 @@
-from dataclasses import dataclass, field
+from dataclasses import field
 from enum import Enum
-from typing import Any, Dict, List, Optional, Set, Type, Union
+from typing import Any, Dict, List, Literal, Optional, Set, Type, Union, Annotated
 
 import jsonschema
 from fastapi.encoders import jsonable_encoder
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, field_validator
+from pydantic.dataclasses import dataclass
 
 from statezero.core.types import ORMField
 
@@ -205,6 +206,213 @@ class FieldGroup:
     field_names: Optional[List[str]] = None
 
 
+# =============================================================================
+# Layout Elements - JSON Forms inspired layout system
+# =============================================================================
+
+class LayoutType(str, Enum):
+    """Types of layout elements"""
+    VERTICAL = "VerticalLayout"
+    HORIZONTAL = "HorizontalLayout"
+    GROUP = "Group"
+    CONTROL = "Control"
+    DISPLAY = "Display"
+    ALERT = "Alert"
+    LABEL = "Label"
+    DIVIDER = "Divider"
+
+
+@dataclass
+class Control:
+    """
+    A form control bound to a serializer field.
+    Uses same attribute names as FieldDisplayConfig for consistency.
+
+    Attributes:
+        field_name: The serializer field this control is bound to
+        display_component: Custom UI component name
+        filter_queryset: Filter options for FK/M2M fields
+        display_help_text: Additional help text
+        extra: Additional custom metadata passed to the component
+        label: Override the field's title
+        full_width: Whether this control should span full width
+    """
+    field_name: str
+    display_component: Optional[str] = None
+    filter_queryset: Optional[Dict[str, Any]] = None
+    display_help_text: Optional[str] = None
+    extra: Optional[Dict[str, Any]] = None
+    label: Optional[str] = None
+    full_width: bool = False
+    type: Literal["Control"] = field(default="Control", init=False)
+
+
+@dataclass
+class Display:
+    """
+    A display-only element that renders data from context.
+    Does not collect input - purely for showing information.
+
+    Attributes:
+        context_path: Dot-notation path to value in workflow context (e.g., "unit.access_code")
+        display_component: UI component to render with (e.g., "code-display", "copy-url")
+        label: Label to show above the display
+        extra: Additional custom metadata passed to the component
+    """
+    context_path: str
+    display_component: str = "text"
+    label: Optional[str] = None
+    extra: Optional[Dict[str, Any]] = None
+    type: Literal["Display"] = field(default="Display", init=False)
+
+
+@dataclass
+class Alert:
+    """
+    An alert/info banner element.
+
+    Attributes:
+        severity: Alert type - "info", "warning", "error", "success"
+        text: Static text to display
+        context_path: Or pull text from context
+    """
+    severity: Literal["info", "warning", "error", "success"] = "info"
+    text: Optional[str] = None
+    context_path: Optional[str] = None
+    type: Literal["Alert"] = field(default="Alert", init=False)
+
+
+@dataclass
+class Label:
+    """
+    A static text label element.
+
+    Attributes:
+        text: The text to display
+        variant: Text style - "heading", "subheading", "body", "caption"
+    """
+    text: str
+    variant: Literal["heading", "subheading", "body", "caption"] = "body"
+    type: Literal["Label"] = field(default="Label", init=False)
+
+
+@dataclass
+class Divider:
+    """A visual separator/divider element."""
+    type: Literal["Divider"] = field(default="Divider", init=False)
+
+
+@dataclass
+class Conditional:
+    """
+    Conditionally render a layout based on form data or context.
+
+    The `when` expression is evaluated as JavaScript with access to:
+    - formData: Current form field values
+    - context: Workflow context data
+
+    Examples:
+        when="formData.payment_method === 'card'"
+        when="context.has_wifi === true"
+        when="formData.amount > 100"
+
+    Attributes:
+        when: JavaScript expression that returns a boolean
+        layout: Layout to render when condition is true
+    """
+    when: str
+    layout: "LayoutElement"
+    type: Literal["Conditional"] = field(default="Conditional", init=False)
+
+
+@dataclass
+class Tab:
+    """
+    A single tab within a Tabs container.
+
+    Attributes:
+        label: Tab button label
+        layout: Content to render when tab is active
+    """
+    label: str
+    layout: "LayoutElement"
+
+
+@dataclass
+class Tabs:
+    """
+    A tabbed container for organizing content into switchable panels.
+
+    Attributes:
+        tabs: List of Tab elements
+        default_tab: Index of initially active tab (0-based)
+    """
+    tabs: List[Tab] = field(default_factory=list)
+    default_tab: int = 0
+    type: Literal["Tabs"] = field(default="Tabs", init=False)
+
+
+# Layout element union type for type hints
+LayoutElement = Union[
+    Control, Display, Alert, Label, Divider, Conditional, Tabs,
+    "VerticalLayout", "HorizontalLayout", "Group"
+]
+
+
+@dataclass
+class VerticalLayout:
+    """
+    Stack elements vertically.
+
+    Attributes:
+        elements: Child layout elements
+        gap: Spacing between elements - "sm", "md", "lg"
+    """
+    elements: List["LayoutElement"] = field(default_factory=list)
+    gap: Literal["sm", "md", "lg"] = "md"
+    type: Literal["VerticalLayout"] = field(default="VerticalLayout", init=False)
+
+
+@dataclass
+class HorizontalLayout:
+    """
+    Stack elements horizontally.
+
+    Attributes:
+        elements: Child layout elements
+        gap: Spacing between elements - "sm", "md", "lg"
+        align: Vertical alignment - "start", "center", "end", "stretch"
+    """
+    elements: List["LayoutElement"] = field(default_factory=list)
+    gap: Literal["sm", "md", "lg"] = "md"
+    align: Literal["start", "center", "end", "stretch"] = "start"
+    type: Literal["HorizontalLayout"] = field(default="HorizontalLayout", init=False)
+
+
+@dataclass
+class Group:
+    """
+    A labeled container/section with nested layout.
+
+    Attributes:
+        label: Section heading
+        description: Section description
+        layout: Nested layout (defaults to VerticalLayout)
+        collapsible: Whether the group can be collapsed
+        collapsed: Initial collapsed state
+    """
+    label: str
+    description: Optional[str] = None
+    layout: Optional["LayoutElement"] = None
+    collapsible: bool = False
+    collapsed: bool = False
+    type: Literal["Group"] = field(default="Group", init=False)
+
+
+# Convenience type for the root layout
+Layout = Union[VerticalLayout, HorizontalLayout]
+
+
 @dataclass
 class DisplayMetadata:
     """
@@ -214,11 +422,16 @@ class DisplayMetadata:
         display_title: Main heading/title override
         display_description: Explanatory text about the model/action
         field_groups: Logical grouping of fields (e.g., "Contact Info", "Address Details")
+            - Legacy: use `layout` for more control
         field_display_configs: Per-field customization (custom components, filters, help text)
+            - Legacy: use Control elements in `layout` for more control
+        layout: Rich layout tree for complex form/display rendering. Takes precedence over
+            field_groups when present. Supports nesting, display-only elements, conditionals, etc.
         extra: Additional custom metadata for framework-specific or UI-specific extensions
     """
     display_title: Optional[str] = None
     display_description: Optional[str] = None
     field_groups: Optional[List[FieldGroup]] = None
     field_display_configs: Optional[List[FieldDisplayConfig]] = None
+    layout: Optional[Layout] = None
     extra: Optional[Dict[str, Any]] = None

{statezero-0.1.0b61 → statezero-0.1.0b62}/statezero.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: statezero
-Version: 0.1.0b61
+Version: 0.1.0b62
 Summary: Connect your Python backend to a modern JavaScript SPA frontend with 90% less complexity.
 Author-email: Robert <robert.herring@statezero.dev>
 Project-URL: homepage, https://www.statezero.dev