feat: bone action identifier

Author: sveneberth

src/viur/assistant/__init__.py

@@ -7,10 +7,13 @@
 from .bones.image import ImageBone, ImageBoneRelSkel
 from .modules.assistant import Assistant
 from .skeletons.assistant import AssistantSkel
+from .bones.actions import BONE_ACTION_KEY, BoneAction
 from .config import CONFIG
 
 __all__ = [
     "Assistant",
+    "BONE_ACTION_KEY",
+    "BoneAction",
     "CONFIG",
     "ImageBone",
     "ImageBoneRelSkel",

src/viur/assistant/bones/actions.py

@@ -0,0 +1,37 @@
+"""
+Bone Actions
+
+This module defines identifiers as they are used in vi-admin
+to activate certain additional actions on a bone.
+
+Examples:
+~~~~~~~~~
+
+    .. code-block:: python
+
+        descr = TextBone(
+            languages=["de", "en"],
+            params={
+                BONE_ACTION_KEY: [BoneAction.TRANSLATE],
+            },
+        )
+
+        descr = ImageBone(
+            params={
+                BONE_ACTION_KEY: [BoneAction.DESCRIBE_IMAGE],
+            },
+        )
+"""
+
+import typing as t
+
+BONE_ACTION_KEY: t.Final[str] = "actions"
+"""The key of the parameter"""
+
+
+class BoneAction:
+    TRANSLATE: t.Final[str] = "translate"
+    """Translate text"""
+
+    DESCRIBE_IMAGE: t.Final[str] = "describe_image"
+    """Describe image with an alt text"""

src/viur/assistant/bones/image.py

@@ -18,11 +18,11 @@ class ImageBone(FileBone):
     type = FileBone.type + ".image"
 
     def __init__(
-            self,
-            *,
-            using: t.Optional[RelSkel] = ImageBoneRelSkel,
-            validMimeTypes: None | t.Iterable[str] = ["image/*"],
-            **kwargs,
+        self,
+        *,
+        using: t.Type[RelSkel] = ImageBoneRelSkel,
+        validMimeTypes: None | t.Iterable[str] = ("image/*",),
+        **kwargs,
     ):
         super().__init__(
             using=using,