add custom operation event for docs

Author: Jens Kürten

csfunctions/events/__init__.py

@@ -2,6 +2,7 @@
 
 from pydantic import Field
 
+from .custom_operations import CustomOperationDocumentData, CustomOperationDocumentEvent
 from .dialog_data import DocumentReleasedDialogData, PartReleasedDialogData
 from .document_create_check import DocumentCreateCheckData, DocumentCreateCheckEvent
 from .document_field_calculation import DocumentFieldCalculationData, DocumentFieldCalculationEvent
@@ -36,6 +37,7 @@
         DocumentModifyCheckEvent,
         PartCreateCheckEvent,
         PartModifyCheckEvent,
+        CustomOperationDocumentEvent,
     ],
     Field(discriminator="name"),
 ]
@@ -55,6 +57,7 @@
     DocumentModifyCheckData,
     PartCreateCheckData,
     PartModifyCheckData,
+    CustomOperationDocumentData,
 ]
 
 __all__ = [
@@ -90,4 +93,6 @@
     "PartCreateCheckEvent",
     "PartModifyCheckData",
     "PartModifyCheckEvent",
+    "CustomOperationDocumentData",
+    "CustomOperationDocumentEvent",
 ]

csfunctions/events/base.py

@@ -19,6 +19,7 @@ class EventNames(str, Enum):
     DOCUMENT_MODIFY_CHECK = "document_modify_check"
     PART_CREATE_CHECK = "part_create_check"
     PART_MODIFY_CHECK = "part_modify_check"
+    CUSTOM_OPERATION_DOCUMENT = "custom_operation_document"
 
 
 class BaseEvent(BaseModel):

csfunctions/events/custom_operations.py

@@ -0,0 +1,21 @@
+from typing import Literal
+
+from pydantic import BaseModel, Field
+
+from csfunctions.objects import Document, Part
+
+from .base import BaseEvent, EventNames
+
+
+class CustomOperationDocumentData(BaseModel):
+    documents: list[Document] = Field(..., description="List of documents that the custom operation was called on")
+    parts: list[Part] = Field(..., description="List of parts that belong to the documents")
+
+
+class CustomOperationDocumentEvent(BaseEvent):
+    """
+    Event triggered when a custom operation is called on a document.
+    """
+
+    name: Literal[EventNames.CUSTOM_OPERATION_DOCUMENT] = EventNames.CUSTOM_OPERATION_DOCUMENT
+    data: CustomOperationDocumentData

json_schemas/request.json

@@ -85,6 +85,57 @@
       "title": "Briefcase",
       "type": "object"
     },
+    "CustomOperationDocumentData": {
+      "properties": {
+        "documents": {
+          "description": "List of documents that the custom operation was called on",
+          "items": {
+            "$ref": "#/$defs/Document"
+          },
+          "title": "Documents",
+          "type": "array"
+        },
+        "parts": {
+          "description": "List of parts that belong to the documents",
+          "items": {
+            "$ref": "#/$defs/Part"
+          },
+          "title": "Parts",
+          "type": "array"
+        }
+      },
+      "required": [
+        "documents",
+        "parts"
+      ],
+      "title": "CustomOperationDocumentData",
+      "type": "object"
+    },
+    "CustomOperationDocumentEvent": {
+      "description": "Event triggered when a custom operation is called on a document.",
+      "properties": {
+        "name": {
+          "const": "custom_operation_document",
+          "default": "custom_operation_document",
+          "title": "Name",
+          "type": "string"
+        },
+        "event_id": {
+          "description": "unique identifier",
+          "title": "Event Id",
+          "type": "string"
+        },
+        "data": {
+          "$ref": "#/$defs/CustomOperationDocumentData"
+        }
+      },
+      "required": [
+        "event_id",
+        "data"
+      ],
+      "title": "CustomOperationDocumentEvent",
+      "type": "object"
+    },
     "Document": {
       "description": "Normal Document that doesn't contain a CAD-Model.",
       "properties": {
@@ -3068,6 +3119,7 @@
     "event": {
       "discriminator": {
         "mapping": {
+          "custom_operation_document": "#/$defs/CustomOperationDocumentEvent",
           "document_create_check": "#/$defs/DocumentCreateCheckEvent",
           "document_field_calculation": "#/$defs/DocumentFieldCalculationEvent",
           "document_modify_check": "#/$defs/DocumentModifyCheckEvent",
@@ -3131,6 +3183,9 @@
         },
         {
           "$ref": "#/$defs/PartModifyCheckEvent"
+        },
+        {
+          "$ref": "#/$defs/CustomOperationDocumentEvent"
         }
       ],
       "title": "Event"