feat: Add BOMItemFieldCalculationEvent and related data model

Author: Jens Kürten

csfunctions/events/__init__.py

@@ -2,6 +2,7 @@
 
 from pydantic import Field
 
+from .bom_item_field_calculation import BOMItemFieldCalculationData, BOMItemFieldCalculationEvent
 from .custom_operations import (
     CustomOperationDocumentData,
     CustomOperationDocumentEvent,
@@ -37,6 +38,7 @@
     | PartReleasedEvent
     | PartReleaseCheckEvent
     | PartFieldCalculationEvent
+    | BOMItemFieldCalculationEvent
     | FieldValueCalculationEvent
     | DummyEvent
     | EngineeringChangeReleasedEvent
@@ -59,6 +61,7 @@
     | PartReleasedData
     | PartReleaseCheckData
     | PartFieldCalculationData
+    | BOMItemFieldCalculationData
     | FieldValueCalculationData
     | DummyEventData
     | EngineeringChangeReleasedData
@@ -81,6 +84,7 @@
     "PartReleasedEvent",
     "PartReleaseCheckEvent",
     "PartFieldCalculationEvent",
+    "BOMItemFieldCalculationEvent",
     "FieldValueCalculationEvent",
     "DummyEvent",
     "EngineeringChangeReleasedEvent",
@@ -91,6 +95,7 @@
     "DocumentFieldCalculationData",
     "PartReleasedData",
     "PartReleaseCheckData",
+    "BOMItemFieldCalculationData",
     "FieldValueCalculationData",
     "DummyEventData",
     "EngineeringChangeReleasedData",

csfunctions/events/base.py

@@ -11,6 +11,7 @@ class EventNames(str, Enum):
     PART_RELEASED = "part_released"
     PART_RELEASE_CHECK = "part_release_check"
     PART_FIELD_CALCULATION = "part_field_calculation"
+    BOM_ITEM_FIELD_CALCULATION = "bom_item_field_calculation"
     ENGINEERING_CHANGE_RELEASED = "engineering_change_released"
     ENGINEERING_CHANGE_RELEASE_CHECK = "engineering_change_release_check"
     FIELD_VALUE_CALCULATION = "field_value_calculation"

csfunctions/events/bom_item_field_calculation.py

@@ -0,0 +1,18 @@
+from typing import Literal
+
+from pydantic import BaseModel, Field
+
+from csfunctions.objects import BOMItem, Part
+
+from .base import BaseEvent, EventNames
+
+
+class BOMItemFieldCalculationData(BaseModel):
+    bom_item: BOMItem = Field(..., description="Current state of the BOM item")
+    action: Literal["create", "modify", "copy", "index"] = Field(..., description="Action being performed")
+    part: Part = Field(..., description="Part of the BOM item")
+
+
+class BOMItemFieldCalculationEvent(BaseEvent):
+    name: Literal[EventNames.BOM_ITEM_FIELD_CALCULATION] = EventNames.BOM_ITEM_FIELD_CALCULATION
+    data: BOMItemFieldCalculationData

docs/reference/events.md

@@ -265,6 +265,24 @@ The event expects a DataResponse containing a dictionary of field names and thei
 | documents | list[[Document](objects.md#document)]        | List of documents that belong to the part |
 
 
+## BOMItemFieldCalculationEvent
+`csfunctions.events.BOMItemFieldCalculationEvent`
+
+This event is fired when a BOM item is created, modified, copied or indexed. It is triggered after the field calculations defined in the datasheet editor are performed.
+
+The event expects a DataResponse containing a dictionary of field names and their new values. Fields that are not mentioned in the response are not updated.
+
+**BOMItemFieldCalculationEvent.name:** bom_item_field_calculation
+
+**BOMItemFieldCalculationEvent.data:**
+
+| Attribute | Type                                         | Description                   |
+| --------- | -------------------------------------------- | ----------------------------- |
+| bom_item  | [BOMItem](objects.md#bomitem)                | Current state of the BOM item |
+| action    | Literal["create", "modify", "copy", "index"] | Action being performed        |
+| part      | [Part](objects.md#part)                      | Part of the BOM item          |
+
+
 ## WorkflowTaskTriggerEvent
 `csfunctions.events.WorkflowTaskTriggerEvent`