feat: part field calculation event

Author: Jens Kürten

csfunctions/events/__init__.py

@@ -10,6 +10,7 @@
 from .engineering_change_release import EngineeringChangeRelease, EngineeringChangeReleaseData
 from .engineering_change_release_check import EngineeringChangeReleaseCheck, EngineeringChangeReleaseCheckData
 from .field_value_calculation import FieldValueCalculationData, FieldValueCalculationEvent
+from .part_field_calculation import PartFieldCalculationData, PartFieldCalculationEvent
 from .part_release import PartReleaseData, PartReleaseEvent
 from .part_release_check import PartReleaseCheckData, PartReleaseCheckEvent
 from .workflow_task_trigger import WorkflowTaskTriggerEvent, WorkflowTaskTriggerEventData
@@ -21,6 +22,7 @@
         DocumentFieldCalculationEvent,
         PartReleaseEvent,
         PartReleaseCheckEvent,
+        PartFieldCalculationEvent,
         FieldValueCalculationEvent,
         DummyEvent,
         EngineeringChangeRelease,
@@ -35,6 +37,7 @@
     DocumentFieldCalculationData,
     PartReleaseData,
     PartReleaseCheckData,
+    PartFieldCalculationData,
     FieldValueCalculationData,
     DummyEventData,
     EngineeringChangeReleaseData,
@@ -48,6 +51,7 @@
     "DocumentFieldCalculationEvent",
     "PartReleaseEvent",
     "PartReleaseCheckEvent",
+    "PartFieldCalculationEvent",
     "FieldValueCalculationEvent",
     "DummyEvent",
     "EngineeringChangeRelease",
@@ -65,4 +69,5 @@
     "WorkflowTaskTriggerEventData",
     "DocumentReleaseDialogData",
     "PartReleaseDialogData",
+    "PartFieldCalculationData",
 ]

csfunctions/events/base.py

@@ -10,6 +10,7 @@ class EventNames(str, Enum):
     DOCUMENT_FIELD_CALCULATION = "document_field_calculation"
     PART_RELEASE = "part_release"
     PART_RELEASE_CHECK = "part_release_check"
+    PART_FIELD_CALCULATION = "part_field_calculation"
     ENGINEERING_CHANGE_RELEASE = "engineering_change_release"
     ENGINEERING_CHANGE_RELEASE_CHECK = "engineering_change_release_check"
     FIELD_VALUE_CALCULATION = "field_value_calculation"

csfunctions/events/part_field_calculation.py

@@ -0,0 +1,20 @@
+from typing import Literal
+
+from pydantic import BaseModel, Field
+
+from csfunctions.objects import Document, Part
+
+from .base import BaseEvent, EventNames
+
+
+class PartFieldCalculationData(BaseModel):
+    part: Part = Field(..., description="Current state of the part")
+    action: Literal["create", "modify", "copy", "index"] = Field(..., description="Action being performed")
+
+    linked_documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
+    linked_parts: list[Part] = Field(..., description="Related parts (e.g. source part)")
+
+
+class PartFieldCalculationEvent(BaseEvent):
+    name: Literal[EventNames.PART_FIELD_CALCULATION] = EventNames.PART_FIELD_CALCULATION
+    data: PartFieldCalculationData

json_schemas/request.json

@@ -2490,6 +2490,73 @@
       "title": "Part",
       "type": "object"
     },
+    "PartFieldCalculationData": {
+      "properties": {
+        "part": {
+          "$ref": "#/$defs/Part",
+          "description": "Current state of the part"
+        },
+        "action": {
+          "description": "Action being performed",
+          "enum": [
+            "create",
+            "modify",
+            "copy",
+            "index"
+          ],
+          "title": "Action",
+          "type": "string"
+        },
+        "linked_documents": {
+          "description": "List of documents that are referenced by the parts.",
+          "items": {
+            "$ref": "#/$defs/Document"
+          },
+          "title": "Linked Documents",
+          "type": "array"
+        },
+        "linked_parts": {
+          "description": "Related parts (e.g. source part)",
+          "items": {
+            "$ref": "#/$defs/Part"
+          },
+          "title": "Linked Parts",
+          "type": "array"
+        }
+      },
+      "required": [
+        "part",
+        "action",
+        "linked_documents",
+        "linked_parts"
+      ],
+      "title": "PartFieldCalculationData",
+      "type": "object"
+    },
+    "PartFieldCalculationEvent": {
+      "properties": {
+        "name": {
+          "const": "part_field_calculation",
+          "default": "part_field_calculation",
+          "title": "Name",
+          "type": "string"
+        },
+        "event_id": {
+          "description": "unique identifier",
+          "title": "Event Id",
+          "type": "string"
+        },
+        "data": {
+          "$ref": "#/$defs/PartFieldCalculationData"
+        }
+      },
+      "required": [
+        "event_id",
+        "data"
+      ],
+      "title": "PartFieldCalculationEvent",
+      "type": "object"
+    },
     "PartReleaseCheckData": {
       "properties": {
         "parts": {
@@ -2823,6 +2890,7 @@
           "engineering_change_release": "#/$defs/EngineeringChangeRelease",
           "engineering_change_release_check": "#/$defs/EngineeringChangeReleaseCheck",
           "field_value_calculation": "#/$defs/FieldValueCalculationEvent",
+          "part_field_calculation": "#/$defs/PartFieldCalculationEvent",
           "part_release": "#/$defs/PartReleaseEvent",
           "part_release_check": "#/$defs/PartReleaseCheckEvent",
           "workflow_task_trigger": "#/$defs/WorkflowTaskTriggerEvent"
@@ -2845,6 +2913,9 @@
         {
           "$ref": "#/$defs/PartReleaseCheckEvent"
         },
+        {
+          "$ref": "#/$defs/PartFieldCalculationEvent"
+        },
         {
           "$ref": "#/$defs/FieldValueCalculationEvent"
         },