added SDK new function get_editor_context

tod

Author: VaghinakDev

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

@@ -5,6 +5,7 @@
 import logging
 import os
 import sys
+import typing
 import warnings
 from pathlib import Path
 from typing import Any
@@ -277,6 +278,55 @@ def get_team_metadata(self):
         response = self.controller.get_team()
         return TeamSerializer(response.data).serialize()
 
+    def get_editor_context(self, project: Union[NotEmptyStr, int], component_id: str):
+        """
+        Retrieves the editor context for a given project and component ID.
+
+        :param project: The identifier of the project, which can be a string or an integer representing the project ID.
+        :type project: Union[str, int]
+
+        :param component_id: The ID of the component for which the context is to be retrieved.
+        :type component_id: str
+
+        :return: The context associated with the `webComponent`.
+        :rtype: Any
+
+        :raises AppException: If the project type is not `MULTIMODAL` or no `webComponent` context is found.
+        """
+
+        def retrieve_context(
+            component_data: List[dict], component_pk: str
+        ) -> Tuple[bool, typing.Any]:
+            for component in component_data:
+                if (
+                    component["type"] == "webComponent"
+                    and component["id"] == component_pk
+                ):
+                    return True, component.get("context")
+                if component["type"] == "group" and "children" in component:
+                    found, val = retrieve_context(component["children"], component_pk)
+                    if found:
+                        return found, val
+            return False, None
+
+        project = (
+            self.controller.get_project(project)
+            if isinstance(project, int)
+            else self.controller.get_project_by_id(project)
+        )
+        if project.type != ProjectType.MULTIMODAL:
+            raise AppException(
+                "This function is only supported for Multimodal projects."
+            )
+
+        editor_template = self.controller.projects.get_editor_template(project)
+        components = editor_template.get("components", [])
+
+        _found, _context = retrieve_context(components, component_id)
+        if not _found:
+            raise AppException("No component context found for project.")
+        return _context
+
     def search_team_contributors(
         self,
         email: EmailStr = None,

src/superannotate/lib/infrastructure/controller.py

@@ -88,6 +88,10 @@ def __init__(self, service_provider: ServiceProvider):
 
 
 class ProjectManager(BaseManager):
+    def __init__(self, service_provider: ServiceProvider, team: TeamEntity):
+        super().__init__(service_provider)
+        self._team = team
+
     def get_by_id(self, project_id):
         use_case = usecases.GetProjectByIDUseCase(
             project_id=project_id, service_provider=self.service_provider
@@ -239,6 +243,13 @@ def upload_priority_scores(
         )
         return use_case.execute()
 
+    def get_editor_template(self, project: ProjectEntity) -> dict:
+        response = self.service_provider.projects.get_editor_template(
+            team=self._team, project=project
+        )
+        response.raise_for_status()
+        return response.data
+
 
 class AnnotationClassManager(BaseManager):
     @timed_lru_cache(seconds=3600)
@@ -974,7 +985,7 @@ def __init__(self, config: ConfigEntity):
         self._user = self.get_current_user()
         self._team = self.get_team().data
         self.annotation_classes = AnnotationClassManager(self.service_provider)
-        self.projects = ProjectManager(self.service_provider)
+        self.projects = ProjectManager(self.service_provider, team=self._team)
         self.folders = FolderManager(self.service_provider)
         self.items = ItemManager(self.service_provider)
         self.annotations = AnnotationManager(self.service_provider, config)