add custom operation for part

Author: Jens Kürten

csfunctions/events/__init__.py

@@ -2,7 +2,12 @@
 
 from pydantic import Field
 
-from .custom_operations import CustomOperationDocumentData, CustomOperationDocumentEvent
+from .custom_operations import (
+    CustomOperationDocumentData,
+    CustomOperationDocumentEvent,
+    CustomOperationPartData,
+    CustomOperationPartEvent,
+)
 from .dialog_data import DocumentReleasedDialogData, PartReleasedDialogData
 from .document_create_check import DocumentCreateCheckData, DocumentCreateCheckEvent
 from .document_field_calculation import DocumentFieldCalculationData, DocumentFieldCalculationEvent
@@ -38,6 +43,7 @@
         PartCreateCheckEvent,
         PartModifyCheckEvent,
         CustomOperationDocumentEvent,
+        CustomOperationPartEvent,
     ],
     Field(discriminator="name"),
 ]
@@ -58,6 +64,7 @@
     PartCreateCheckData,
     PartModifyCheckData,
     CustomOperationDocumentData,
+    CustomOperationPartData,
 ]
 
 __all__ = [
@@ -95,4 +102,6 @@
     "PartModifyCheckEvent",
     "CustomOperationDocumentData",
     "CustomOperationDocumentEvent",
+    "CustomOperationPartData",
+    "CustomOperationPartEvent",
 ]

csfunctions/events/base.py

@@ -20,6 +20,7 @@ class EventNames(str, Enum):
     PART_CREATE_CHECK = "part_create_check"
     PART_MODIFY_CHECK = "part_modify_check"
     CUSTOM_OPERATION_DOCUMENT = "custom_operation_document"
+    CUSTOM_OPERATION_PART = "custom_operation_part"
 
 
 class BaseEvent(BaseModel):

csfunctions/events/custom_operations.py

@@ -7,6 +7,7 @@
 from .base import BaseEvent, EventNames
 
 
+# ----------- DOCUMENTS -----------
 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")
@@ -19,3 +20,20 @@ class CustomOperationDocumentEvent(BaseEvent):
 
     name: Literal[EventNames.CUSTOM_OPERATION_DOCUMENT] = EventNames.CUSTOM_OPERATION_DOCUMENT
     data: CustomOperationDocumentData
+
+
+# ----------- PARTS -----------
+
+
+class CustomOperationPartData(BaseModel):
+    parts: list[Part] = Field(..., description="List of parts that the custom operation was called on")
+    documents: list[Document] = Field(..., description="List of documents that belong to the parts")
+
+
+class CustomOperationPartEvent(BaseEvent):
+    """
+    Event triggered when a custom operation is called on a part.
+    """
+
+    name: Literal[EventNames.CUSTOM_OPERATION_PART] = EventNames.CUSTOM_OPERATION_PART
+    data: CustomOperationPartData

json_schemas/request.json

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