added user custom fields support

Author: VaghinakDev

src/superannotate/lib/app/interface/sdk_interface.py

@@ -55,6 +55,7 @@
 from lib.core.entities.integrations import IntegrationEntity
 from lib.core.entities.integrations import IntegrationTypeEnum
 from lib.core.enums import ImageQuality
+from lib.core.enums import CustomFieldEntityEnum
 from lib.core.enums import ProjectType
 from lib.core.enums import ClassTypeEnum
 from lib.core.exceptions import AppException
@@ -280,10 +281,10 @@ def get_team_metadata(self):
         return TeamSerializer(response.data).serialize()
 
     def get_user_metadata(
-        self, pk: Union[str, int], include: List[Literal["custom_fields"]] = None
+        self, pk: Union[int, str], include: List[Literal["custom_fields"]] = None
     ):
         """
-        Returns team contributor metadata
+        Returns user metadata
 
         :param pk: The email address or ID of the team contributor.
         :type pk: str or int
@@ -299,8 +300,58 @@ def get_user_metadata(
         :return: metadata of team contributor
         :rtype: dict
         """
-        response = self.controller.get_user_metadata()
-        return TeamSerializer(response.data).serialize()
+        user = self.controller.work_management.get_user_metadata(pk=pk, include=include)
+        return BaseSerializer(user).serialize(by_alias=False)
+
+    def set_user_custom_field(
+        self, pk: Union[int, str], custom_field_name: str, value: Any
+    ):
+        """
+        Set the custom field for team contributors.
+
+        :param pk: The email address or ID of the team contributor.
+        :type pk: str or int
+
+        :param custom_field_name: the name of the custom field created for the team contributor,
+                                    used to set or update its value.
+
+        :type custom_field_name: str
+
+        :param value: The value
+        :type value: Any
+
+         Request Example:
+        ::
+            from superannotate import SAClient
+
+
+            sa = SAClient()
+
+            client.set_user_custom_field(
+                "example@email.com",
+                custom_field_name="Due date",
+                value="Dec 20, 2024"
+            )
+        """
+        user_id = self.controller.work_management.get_user_metadata(pk=pk).id
+        self.controller.work_management.set_custom_field_value(
+            entity_id=user_id,
+            field_name=custom_field_name,
+            value=value,
+            entity=CustomFieldEntityEnum.CONTRIBUTOR,
+            parent_entity=CustomFieldEntityEnum.TEAM,
+        )
+
+    def list_users(self, *, include: List[Literal["custom_fields"]] = None, **filters):
+        """
+
+        @param include:
+        @param filters:
+        @return:
+        """
+        return BaseSerializer.serialize_iterable(
+            self.controller.work_management.list_users(include=include, **filters)
+        )
 
     def get_component_config(self, project: Union[NotEmptyStr, int], component_id: str):
         """

src/superannotate/lib/core/entities/__init__.py

@@ -14,6 +14,7 @@
 from lib.core.entities.project import AttachmentEntity
 from lib.core.entities.project import CategoryEntity
 from lib.core.entities.project import ContributorEntity
+from lib.core.entities.project import CustomFieldEntity
 from lib.core.entities.project import ProjectEntity
 from lib.core.entities.project import SettingEntity
 from lib.core.entities.project import StepEntity
@@ -28,6 +29,7 @@
     "ConfigEntity",
     "SettingEntity",
     "SubSetEntity",
+    "CustomFieldEntity",
     # items
     "BaseEntity",
     "ImageEntity",

src/superannotate/lib/core/entities/filters.py

@@ -37,3 +37,19 @@ class ProjectFilters(BaseFilters):
     status__ne: Literal["NotStarted", "InProgress", "Completed", "OnHold"]
     status__in: List[Literal["NotStarted", "InProgress", "Completed", "OnHold"]]
     status__notin: List[Literal["NotStarted", "InProgress", "Completed", "OnHold"]]
+    custom_field: Optional[str]  # dummy field to pass first level validation
+
+
+class UserFilters(TypedDict, total=False):
+    id: Optional[int]
+    id__in: Optional[List[int]]
+    email: Optional[str]
+    email__in: Optional[List[str]]
+    email__contains: Optional[str]
+    email__starts: Optional[str]
+    email__ends: Optional[str]
+    state: Optional[str]
+    state__in: Optional[List[str]]
+    role: Optional[str]
+    role__in: Optional[List[str]]
+    custom_field: Optional[str]  # dummy field to pass first level validation

src/superannotate/lib/core/entities/project.py

@@ -170,6 +170,13 @@ class Config:
         extra = Extra.ignore
 
 
+class CustomFieldEntity(BaseModel):
+    ...
+
+    class Config:
+        extra = Extra.allow
+
+
 class WorkflowEntity(BaseModel):
     id: Optional[int]
     name: Optional[str]

src/superannotate/lib/core/entities/work_managament.py

@@ -1,4 +1,5 @@
 import datetime
+from enum import auto
 from enum import Enum
 from typing import Optional
 
@@ -9,14 +10,6 @@
 from lib.core.pydantic_v1 import validator
 
 
-class ProjectCustomFieldType(Enum):
-    Text = 1
-    MULTI_SELECT = 2
-    SINGLE_SELECT = 3
-    DATE_PICKER = 4
-    NUMERIC = 5
-
-
 class ProjectType(str, Enum):
     Vector = "VECTOR"
     Pixel = "PIXEL"
@@ -28,6 +21,25 @@ class ProjectType(str, Enum):
     Multimodal = "CUSTOM_LLM"
 
 
+class WMUserStateEnum(str, Enum):
+    Pending = "PENDING"
+    Confirmed = "CONFIRMED"
+    Video = "PUBLIC_VIDEO"
+    Document = "PUBLIC_TEXT"
+    Tiled = "TILED"
+    Other = "CLASSIFICATION"
+    PointCloud = "POINT_CLOUD"
+    Multimodal = "CUSTOM_LLM"
+
+
+class WMUserTypeEnum(int, Enum):
+    Contributor = 4
+    TeamAdmin = 7
+    TeamOwner = 12
+    OrganizationAdmin = 15
+    other = auto()
+
+
 class ProjectStatus(str, Enum):
     Undefined = "undefined"
     NotStarted = "notStarted"
@@ -89,12 +101,31 @@ def json(self, **kwargs):
         return super().json(**kwargs)
 
 
-class UserEntity(TimedBaseModel):
-    id: Optional[str]
-    first_name: Optional[str]
-    last_name: Optional[str]
+class WMUserEntity(TimedBaseModel):
+    id: Optional[int]
+    team_id: Optional[int]
+    role: WMUserTypeEnum
     email: Optional[str]
-    user_role: Optional[int]
+    state: Optional[WMUserStateEnum]
+    custom_fields: Optional[dict] = Field(dict(), alias="customField")
 
     class Config:
         extra = Extra.ignore
+        use_enum_names = True
+
+        json_encoders = {
+            Enum: lambda v: v.value,
+            datetime.date: lambda v: v.isoformat(),
+            datetime.datetime: lambda v: v.isoformat(),
+        }
+
+    @validator("custom_fields")
+    def custom_fields_transformer(cls, v):
+        if v and "custom_field_values" in v:
+            return v.get("custom_field_values", {})
+        return {}
+
+    def json(self, **kwargs):
+        if "exclude" not in kwargs:
+            kwargs["exclude"] = {"custom_fields"}
+        return super().json(**kwargs)

src/superannotate/lib/core/enums.py

@@ -185,3 +185,17 @@ class TrainingStatus(BaseTitledEnum):
     FAILED_BEFORE_EVALUATION = "FailedBeforeEvaluation", 4
     FAILED_AFTER_EVALUATION = "FailedAfterEvaluation", 5
     FAILED_AFTER_EVALUATION_WITH_SAVE_MODEL = "FailedAfterEvaluationWithSavedModel", 6
+
+
+class CustomFieldEntityEnum(str, Enum):
+    CONTRIBUTOR = "Contributor"
+    TEAM = "Team"
+    PROJECT = "Project"
+
+
+class CustomFieldType(Enum):
+    Text = 1
+    MULTI_SELECT = 2
+    SINGLE_SELECT = 3
+    DATE_PICKER = 4
+    NUMERIC = 5

src/superannotate/lib/core/service_types.py

@@ -252,6 +252,10 @@ class WMUserListResponse(ServiceResponse):
     res_data: List[WMUserEntity] = None
 
 
+class WMCustomFieldResponse(ServiceResponse):
+    res_data: List[entities.CustomFieldEntity] = None
+
+
 class SettingsListResponse(ServiceResponse):
     res_data: List[entities.SettingEntity] = None
 

src/superannotate/lib/core/serviceproviders.py

@@ -6,9 +6,11 @@
 from typing import Dict
 from typing import List
 from typing import Literal
+from typing import Optional
 
 from lib.core import entities
 from lib.core.conditions import Condition
+from lib.core.enums import CustomFieldEntityEnum
 from lib.core.jsx_conditions import Query
 from lib.core.reporter import Reporter
 from lib.core.service_types import AnnotationClassListResponse
@@ -25,7 +27,9 @@
 from lib.core.service_types import UploadAnnotationsResponse
 from lib.core.service_types import UserLimitsResponse
 from lib.core.service_types import UserResponse
+from lib.core.service_types import WMCustomFieldResponse
 from lib.core.service_types import WMProjectListResponse
+from lib.core.service_types import WMUserListResponse
 from lib.core.service_types import WorkflowListResponse
 from lib.core.types import Attachment
 from lib.core.types import AttachmentMeta
@@ -103,15 +107,17 @@ def list_workflow_roles(self, project_id: int, workflow_id: int):
         raise NotImplementedError
 
     @abstractmethod
-    def list_project_custom_field_templates(self):
+    def list_custom_field_templates(
+        self,
+        entity: CustomFieldEntityEnum,
+        parent_entity: CustomFieldEntityEnum,
+        context: dict = None,
+    ):
         raise NotImplementedError
 
     def create_project_custom_field_template(self, data: dict):
         raise NotImplementedError
 
-    def delete_project_custom_field_template(self, pk: int):
-        raise NotImplementedError
-
     @abstractmethod
     def list_project_custom_entities(self, project_id: int):
         raise NotImplementedError
@@ -136,6 +142,47 @@ def create_project_categories(
     ) -> ServiceResponse:
         raise NotImplementedError
 
+    @abstractmethod
+    def list_users(
+        self, body_query: Query, chunk_size=100, include_custom_fields=False
+    ) -> WMUserListResponse:
+        raise NotImplementedError
+
+    @abstractmethod
+    def create_custom_field_template(
+        self,
+        name: str,
+        component_id: int,
+        entity: CustomFieldEntityEnum,
+        parent_entity: CustomFieldEntityEnum,
+        component_payload: Optional[dict] = None,
+        access: Optional[dict] = None,
+        entity_context: Optional[dict] = None,
+    ) -> WMCustomFieldResponse:
+        raise NotImplementedError
+
+    @abstractmethod
+    def delete_custom_field_template(
+        self,
+        pk: int,
+        entity: CustomFieldEntityEnum,
+        parent_entity: CustomFieldEntityEnum,
+        entity_context: Optional[dict] = None,
+    ):
+        raise NotImplementedError
+
+    @abstractmethod
+    def set_custom_field_value(
+        self,
+        entity_id: int,
+        template_id: int,
+        data: dict,
+        entity: CustomFieldEntityEnum,
+        parent_entity: CustomFieldEntityEnum,
+        context: Optional[dict] = None,
+    ):
+        raise NotImplementedError
+
 
 class BaseProjectService(SuperannotateServiceProvider):
     @abstractmethod
@@ -738,17 +785,23 @@ def invite_contributors(
         raise NotImplementedError
 
     @abstractmethod
-    def list_project_custom_field_names(self) -> List[str]:
+    def list_custom_field_names(self, entity: CustomFieldEntityEnum) -> List[str]:
         raise NotImplementedError
 
     @abstractmethod
-    def get_project_custom_field_id(self, field_name: str) -> int:
+    def get_custom_field_id(
+        self, field_name: str, entity: CustomFieldEntityEnum
+    ) -> int:
         raise NotImplementedError
 
     @abstractmethod
-    def get_project_custom_field_name(self, field_id: int) -> str:
+    def get_custom_field_name(
+        self, field_id: int, entity: CustomFieldEntityEnum
+    ) -> str:
         raise NotImplementedError
 
     @abstractmethod
-    def get_project_custom_field_component_id(self, field_id: int) -> str:
+    def get_custom_field_component_id(
+        self, field_id: int, entity: CustomFieldEntityEnum
+    ) -> str:
         raise NotImplementedError