updates

Author: pcrespov

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

@@ -1,7 +1,7 @@
 from datetime import datetime
 from typing import Annotated, Self
 
-from models_library.string_types import NameSafeStr
+from models_library.string_types import DisplaySafeStr
 from pydantic import ConfigDict, Field, field_validator
 
 from ..access_rights import AccessRights
@@ -53,7 +53,7 @@ def from_domain_model(
 
 
 class FolderCreateBodyParams(InputSchema):
-    name: NameSafeStr
+    name: DisplaySafeStr
     parent_folder_id: FolderID | None = None
     workspace_id: WorkspaceID | None = None
     model_config = ConfigDict(extra="forbid")
@@ -68,7 +68,7 @@ class FolderCreateBodyParams(InputSchema):
 
 
 class FolderReplaceBodyParams(InputSchema):
-    name: NameSafeStr
+    name: DisplaySafeStr
     parent_folder_id: FolderID | None = None
     model_config = ConfigDict(extra="forbid")
 

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

@@ -165,11 +165,25 @@ def validate_input_xss_safety(value: str) -> str:
         strip_whitespace=True,
         min_length=1,
         max_length=MAX_NAME_LENGTH,
-        pattern=r"^[A-Za-z0-9 ._-]+$",  # string that ONLY contains alphanumeric characters, spaces, dots, underscores, or hyphens
+        pattern=r"^[A-Za-z0-9 ._-]+$",
+        # CAREFUL: string that ONLY contains alphanumeric characters, spaces, dots, underscores, or hyphens
     ),
     AfterValidator(validate_input_xss_safety),
+    annotated_types.doc(
+        """ A safe string used in **name identifiers**, It might be very restrictive for display names (e.g. titles or labels) """
+    ),
 ]
 
+DisplaySafeStr: TypeAlias = Annotated[
+    str,
+    StringConstraints(
+        strip_whitespace=True,
+        min_length=1,
+        max_length=MAX_NAME_LENGTH,
+    ),
+    AfterValidator(validate_input_xss_safety),
+    annotated_types.doc(""" Like `NameSafeStr` but more suited for display names"""),
+]
 
 DescriptionSafeStr: TypeAlias = Annotated[
     str,
@@ -200,7 +214,7 @@ def validate_input_xss_safety(value: str) -> str:
         strip_whitespace=True,
         min_length=1,
         max_length=200,
-        pattern=r"^[A-Za-z0-9 ._-]*$",  # Allow alphanumeric, spaces, dots, underscores, hyphens, and asterisks
+        pattern=r"^[A-Za-z0-9 ._@-]*$",  # Allow alphanumeric, spaces, dots, underscores, hyphens, and at signs
     ),
     AfterValidator(validate_input_xss_safety),
     annotated_types.doc(