fastlifeweb 0.27.0__py3-none-any.whl → 0.28.0__py3-none-any.whl

fastlife/adapters/xcomponent/html/table.py

@@ -0,0 +1,130 @@
+"""Table components."""
+
+from collections.abc import Mapping
+
+from xcomponent import XNode
+
+from fastlife.adapters.xcomponent.catalog import catalog
+
+
+@catalog.component
+def Table(
+    children: XNode,
+    globals: Mapping[str, str],
+    id: str | None = None,
+    class_: str | None = None,
+) -> str:
+    """
+    html ``<table>`` node.
+
+    :param id: unique identifier of the element.
+    :param class_: css class for the node, defaults to
+        :attr:`fastlife.template_globals.Globals.TABLE_CLASS`.
+    """
+    return """
+    <table id={id} class={class_ or globals.TABLE_CLASS}>
+        {children}
+    </table>
+    """
+
+
+@catalog.component
+def Thead(
+    children: XNode,
+    globals: Mapping[str, str],
+    id: str | None = None,
+    class_: str | None = None,
+) -> str:
+    """
+    html ``<thead>`` node.
+
+    :param id: unique identifier of the element.
+    :param class_: css class for the node
+    """
+    return """
+    <thead id={id} class={class_}>
+        {children}
+    </thead>
+    """
+
+
+@catalog.component
+def Tbody(
+    children: XNode,
+    globals: Mapping[str, str],
+    id: str | None = None,
+    class_: str | None = None,
+) -> str:
+    """
+    html ``<tbody>`` node.
+
+    :param id: unique identifier of the element.
+    :param class_: css class for the node
+    """
+    return """
+    <tbody id={id} class={class_}>
+        {children}
+    </tbody>
+    """
+
+
+@catalog.component
+def Tfoot(
+    children: XNode,
+    globals: Mapping[str, str],
+    id: str | None = None,
+    class_: str | None = None,
+) -> str:
+    """
+    html ``<tfoot>`` node.
+
+    :param id: unique identifier of the element.
+    :param class_: css class for the node
+    """
+    return """
+    <tfoot id={id} class={class_}>
+        {children}
+    </tfoot>
+    """
+
+
+@catalog.component
+def Th(
+    children: XNode,
+    globals: Mapping[str, str],
+    id: str | None = None,
+    class_: str | None = None,
+) -> str:
+    """
+    html ``<th>`` node.
+
+    :param id: unique identifier of the element.
+    :param class_: css class for the node, defaults to
+        :attr:`fastlife.template_globals.Globals.TH_CLASS`.
+    """
+    return """
+    <th id={id} class={class_ or globals.TH_CLASS}>
+        {children}
+    </th>
+    """
+
+
+@catalog.component
+def Td(
+    children: XNode,
+    globals: Mapping[str, str],
+    id: str | None = None,
+    class_: str | None = None,
+) -> str:
+    """
+    html ``<td>`` node.
+
+    :param id: unique identifier of the element.
+    :param class_: css class for the node, defaults to
+        :attr:`fastlife.template_globals.Globals.TD_CLASS`.
+    """
+    return """
+    <td id={id} class={class_ or globals.TD_CLASS}>
+        {children}
+    </td>
+    """

fastlife/adapters/xcomponent/html/text.py

@@ -0,0 +1,30 @@
+"""Text components."""
+
+from collections.abc import Mapping
+
+from xcomponent import XNode
+
+from fastlife.adapters.xcomponent.catalog import catalog
+
+
+@catalog.component
+def P(
+    children: XNode,
+    globals: Mapping[str, str],
+    id: str | None = None,
+    class_: str | None = None,
+) -> str:
+    """
+    <p> html tag rendering
+
+    :param children: child node.
+    :param globals: injected root component globals variables.
+    :param id: unique identifier of the element.
+    :param class_: css class for the node, defaults to
+        :attr:`fastlife.template_globals.Globals.P_CLASS`.
+    """
+    return """
+    <p id={id} class={class_ or globals.P_CLASS}>
+      {children}
+    </p>
+    """

fastlife/adapters/xcomponent/html/title.py

@@ -0,0 +1,145 @@
+"""Titles"""
+
+from collections.abc import Mapping
+
+from xcomponent import XNode
+
+from fastlife.adapters.xcomponent.catalog import catalog
+
+
+@catalog.component
+def H1(
+    children: XNode,
+    globals: Mapping[str, str],
+    id: str | None = None,
+    class_: str | None = None,
+) -> str:
+    """
+    <h1> html tag rendering
+
+    :param children: child node.
+    :param globals: injected root component globals variables.
+    :param id: unique identifier of the element.
+    :param class_: css class for the node, defaults to
+        :attr:`fastlife.template_globals.Globals.H1_CLASS`.
+    """
+    return """
+        <h1 id={id} class={class_ or globals.H1_CLASS}>
+            {children}
+        </h1>
+    """
+
+
+@catalog.component
+def H2(
+    children: XNode,
+    globals: Mapping[str, str],
+    id: str | None = None,
+    class_: str | None = None,
+) -> str:
+    """
+    <h2> html tag rendering
+
+    :param children: child node.
+    :param globals: injected root component globals variables.
+    :param id: unique identifier of the element.
+    :param class_: css class for the node, defaults to
+        :attr:`fastlife.template_globals.Globals.H2_CLASS`.
+    """
+    return """
+        <h2 id={id} class={class_ or globals.H2_CLASS}>
+            {children}
+        </h2>
+    """
+
+
+@catalog.component
+def H3(
+    children: XNode,
+    globals: Mapping[str, str],
+    id: str | None = None,
+    class_: str | None = None,
+) -> str:
+    """
+    <h3> html tag rendering
+
+    :param children: child node.
+    :param globals: injected root component globals variables.
+    :param id: unique identifier of the element.
+    :param class_: css class for the node, defaults to
+        :attr:`fastlife.template_globals.Globals.H3_CLASS`.
+    """
+    return """
+        <h3 id={id} class={class_ or globals.H3_CLASS}>
+            {children}
+        </h3>
+    """
+
+
+@catalog.component
+def H4(
+    children: XNode,
+    globals: Mapping[str, str],
+    id: str | None = None,
+    class_: str | None = None,
+) -> str:
+    """
+    <h4> html tag rendering
+
+    :param children: child node.
+    :param globals: injected root component globals variables.
+    :param id: unique identifier of the element.
+    :param class_: css class for the node, defaults to
+        :attr:`fastlife.template_globals.Globals.H4_CLASS`.
+    """
+    return """
+        <h4 id={id} class={class_ or globals.H4_CLASS}>
+            {children}
+        </h4>
+    """
+
+
+@catalog.component
+def H5(
+    children: XNode,
+    globals: Mapping[str, str],
+    id: str | None = None,
+    class_: str | None = None,
+) -> str:
+    """
+    <h5> html tag rendering
+
+    :param children: child node.
+    :param globals: injected root component globals variables.
+    :param id: unique identifier of the element.
+    :param class_: css class for the node, defaults to
+        :attr:`fastlife.template_globals.Globals.H5_CLASS`.
+    """
+    return """
+        <h5 id={id} class={class_ or globals.H5_CLASS}>
+            {children}
+        </h5>
+    """
+
+
+@catalog.component
+def H6(
+    children: XNode,
+    globals: Mapping[str, str],
+    id: str | None = None,
+    class_: str | None = None,
+) -> str:
+    """
+    <h6> html tag rendering
+
+    :param children: child node.
+    :param globals: injected root component globals variables.
+    :param id: unique identifier of the element.
+    :param class_: css class for the node, defaults to
+        :attr:`fastlife.template_globals.Globals.H6_CLASS`.
+    """
+    return """
+        <h6 id={id} class={class_ or globals.H6_CLASS}>
+            {children}
+        </h6>
+    """

fastlife/adapters/xcomponent/icons/icons.py

@@ -0,0 +1,93 @@
+"""Use ``<Icon>`` to load icons."""
+
+import html
+import re
+from functools import cache
+from importlib import util
+from pathlib import Path
+from typing import Literal
+from zipfile import ZipFile
+
+from fastlife.adapters.xcomponent.catalog import catalog
+
+
+@cache
+def icon_path() -> Path:
+    spec = util.find_spec("heroicons")
+    if spec is None or spec.origin is None:
+        raise ValueError("Install heroicons first")  # coverage: ignore
+    return Path(spec.origin).parent
+
+
+@cache
+def get_from_zip(
+    name: str,
+    mode: str,
+) -> str | None:
+    iconzip = icon_path() / "heroicons.zip"
+    with ZipFile(iconzip, "r") as zip_ref:
+        file_list = zip_ref.namelist()
+        for filepath in file_list:
+            if filepath == f"{mode}/{name}.svg":
+                with zip_ref.open(filepath) as file:
+                    return file.read().decode("utf-8")
+    return None
+
+
+@catalog.function
+def load_icon(
+    name: str,
+    mode: str,
+    id: str | None = None,
+    title: str | None = None,
+    class_: str | None = None,
+) -> str:
+    """
+    Function to load the icon behind the scene for  the ``<Icon>`` component.
+
+    :param name: name of the icon.
+    :param mode: mode of the hero icon.
+    :param id: dom unique identifier.
+    :param title: title that can be bubble to the icon.
+    :param class_: css class to set.
+    """
+    icon = get_from_zip(name, mode)
+    if not icon:
+        return ""
+
+    attrs = ""
+    if id:
+        attrs += f' id="{html.escape(id)}"'
+    if class_:
+        attrs += f' class="{html.escape(class_)}"'
+    if attrs:
+        icon = icon.replace(' viewBox="', f'{attrs} viewBox="', 1)
+    if title:
+        icon = re.sub(
+            r"(<path[^>]*?)/>",
+            rf"\1><title>{html.escape(title)}</title></path>",
+            icon,
+        )
+    return icon
+
+
+@catalog.component
+def Icon(
+    name: str,
+    mode: Literal["micro", "mini", "outline", "solid"] = "solid",
+    id: str | None = None,
+    title: str | None = None,
+    class_: str | None = None,
+) -> str:
+    """
+    Add an icon from hero icon package. The svg is already injected to the DOM.
+
+    :param name: name of the icon.
+    :param mode: mode of the hero icon.
+    :param id: dom unique identifier.
+    :param title: title that can be bubble to the icon.
+    :param class_: css class to set.
+    """
+    return """
+    <>{load_icon(name, mode, id, title, class_)}</>
+    """

fastlife/adapters/xcomponent/pydantic_form/components.py

@@ -0,0 +1,121 @@
+from xcomponent import XNode
+
+from fastlife.adapters.xcomponent.catalog import catalog
+
+
+@catalog.component
+def ErrorText(
+    text: str,
+    class_: str,
+) -> str:
+    """
+    display an error for a field.
+
+    :param text: error message
+    :param class_: css class for the node, defaults to
+        :attr:`fastlife.template_globals.Globals.ERROR_CLASS`.
+    """
+    return """
+        <span class={class_ or globals.ERROR_CLASS}>{text}</span>
+    """
+
+
+@catalog.component
+def OptionalErrorText(
+    text: str | None,
+    class_: str | None = None,
+) -> str:
+    """
+    display an error for a field.
+
+    :param text: error message
+    :param class_: css class for the node, defaults to
+        :attr:`fastlife.template_globals.Globals.ERROR_CLASS`.
+    """
+    return """
+    <>
+        {
+            if text {
+                <ErrorText text={text} class={class_} />
+            }
+        }
+    </>
+    """
+
+
+@catalog.component
+def FatalError(
+    message: str | None,
+    class_: str | None = None,
+    icon_class: str | None = None,
+    text_class: str | None = None,
+) -> str:
+    """
+    display an error for a field.
+
+    :param message: error message
+    :param class_: css class for the node, defaults to
+        :attr:`fastlife.template_globals.Globals.FATAL_ERROR_CLASS`.
+    :param icon_class: css class for the node, defaults to :attr:`fastlife.template_globals.Globals.FATAL_ERROR_ICON_CLASS`.
+    :param text_class: css class for the node, defaults to :attr:`fastlife.template_globals.Globals.FATAL_ERROR_TEXT_CLASS`.
+    """
+    return """
+    <>
+    {
+      if message {
+        <div class={class_ or globals.FATAL_ERROR_CLASS} role="alert">
+          <Icon name="fire" class={icon_class or globals.FATAL_ERROR_ICON_CLASS} />
+          <span class={text_class or globals.FATAL_ERROR_TEXT_CLASS}>{message}</span>
+        </div>
+      }
+    }
+    </>
+    """
+
+
+@catalog.component
+def Hint(text: str | None) -> str:
+    """
+    Display a hint message for a field.
+
+    :param text: hint text.
+    """
+    return """
+    <>
+    {
+        if text {
+            <span class="mt-2 text-sm text-neutral-500 dark:text-neutral-400">
+                {text}
+            </span>
+        }
+    }
+    </>
+    """
+
+
+@catalog.component
+def Widget(
+    widget_id: str,
+    removable: bool,
+    children: XNode,
+) -> str:
+    """
+    Base component for widget.
+
+    :param widget_id: widget to display.
+    :param removable: Set to true to add a remove button
+    """
+    return """
+    <div id={widget_id + "-container"}>
+      {children}
+      {
+        if removable {
+          <Button type="button"
+            onclick={"document.getElementById('" + widget_id + "-container').remove()"}
+            >
+            Remove
+         </Button>
+        }
+      }
+    </div>
+    """

fastlife/adapters/xcomponent/pydantic_form/widget_factory/__init__.py

@@ -0,0 +1 @@
+"""Factory for widgets in order to edit pydantic model."""

fastlife/adapters/xcomponent/pydantic_form/widget_factory/base.py

@@ -0,0 +1,40 @@
+"""Abstract class for builder."""
+
+import abc
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, Generic, TypeVar
+
+from pydantic.fields import FieldInfo
+
+from fastlife.adapters.xcomponent.pydantic_form.widgets.base import Widget
+
+if TYPE_CHECKING:
+    from .factory import (  # coverage: ignore
+        WidgetFactory,
+    )
+
+T = TypeVar("T")
+
+
+class BaseWidgetBuilder(abc.ABC, Generic[T]):
+    """Base class for the builder of widget."""
+
+    def __init__(self, factory: "WidgetFactory") -> None:
+        self.factory = factory
+
+    @abc.abstractmethod
+    def accept(self, typ: type[Any], origin: type[Any] | None) -> bool:
+        """Return true if the builder accept to build a widget for this type."""
+
+    @abc.abstractmethod
+    def build(
+        self,
+        *,
+        field_name: str,
+        field_type: type[Any],
+        field: FieldInfo | None,
+        value: T | None,
+        form_errors: Mapping[str, Any],
+        removable: bool,
+    ) -> Widget[T]:
+        """Build the widget"""

fastlife/adapters/xcomponent/pydantic_form/widget_factory/bool_builder.py

@@ -0,0 +1,45 @@
+"""Handle boolean values."""
+
+from collections.abc import Mapping
+from typing import Any
+
+from pydantic.fields import FieldInfo
+
+from fastlife.adapters.xcomponent.pydantic_form.widget_factory.base import (
+    BaseWidgetBuilder,
+)
+from fastlife.adapters.xcomponent.pydantic_form.widgets.boolean import BooleanWidget
+
+
+class BoolBuilder(BaseWidgetBuilder[bool]):
+    """Builder for boolean."""
+
+    def accept(self, typ: type[Any], origin: type[Any] | None) -> bool:
+        """True for boolean."""
+        return issubclass(typ, bool)
+
+    def build(
+        self,
+        *,
+        field_name: str,
+        field_type: type[Any],
+        field: FieldInfo | None,
+        value: bool | None,
+        form_errors: Mapping[str, Any],
+        removable: bool,
+    ) -> BooleanWidget:
+        """Build the widget."""
+        return BooleanWidget(
+            name=field_name,
+            removable=removable,
+            title=field.title or "" if field else "",
+            hint=field.description if field else None,
+            aria_label=(
+                field.json_schema_extra.get("aria_label")  # type:ignore
+                if field and field.json_schema_extra
+                else None
+            ),
+            token=self.factory.token,
+            value=value or False,
+            error=form_errors.get(field_name),
+        )

fastlife/adapters/xcomponent/pydantic_form/widget_factory/emailstr_builder.py

@@ -0,0 +1,50 @@
+"""Handle EmailStr pydantic type."""
+
+from collections.abc import Mapping
+from typing import Any
+
+from pydantic.fields import FieldInfo
+from pydantic.networks import EmailStr
+
+from fastlife.adapters.xcomponent.pydantic_form.widget_factory.base import (
+    BaseWidgetBuilder,
+)
+from fastlife.adapters.xcomponent.pydantic_form.widgets.text import TextWidget
+from fastlife.domain.model.types import Builtins
+
+
+class EmailStrBuilder(BaseWidgetBuilder[Builtins]):
+    """Builder for Pydantic EmailStr."""
+
+    def accept(self, typ: type[Any], origin: type[Any] | None) -> bool:
+        """True for EmailStr."""
+        return issubclass(typ, EmailStr)  # type: ignore
+
+    def build(
+        self,
+        *,
+        field_name: str,
+        field_type: type[Any],
+        field: FieldInfo | None,
+        value: Builtins | None,
+        form_errors: Mapping[str, Any],
+        removable: bool,
+    ) -> TextWidget:
+        """Build the widget."""
+        return TextWidget(
+            name=field_name,
+            input_type="email",
+            placeholder=str(field.examples[0]) if field and field.examples else None,
+            removable=removable,
+            title=field.title or "" if field else "",
+            hint=field.description if field else None,
+            aria_label=(
+                field.json_schema_extra.get("aria_label")  # type:ignore
+                if field and field.json_schema_extra
+                else None
+            ),
+            token=self.factory.token,
+            value=str(value),
+            error=form_errors.get(field_name),
+            autocomplete="email",
+        )