feat: Add new events for document and part checks

Author: Jens Kürten

csfunctions/events/base.py

@@ -13,6 +13,10 @@ class EventNames(str, Enum):
     ENGINEERING_CHANGE_RELEASE_CHECK = "engineering_change_release_check"
     FIELD_VALUE_CALCULATION = "field_value_calculation"
     WORKFLOW_TASK_TRIGGER = "workflow_task_trigger"
+    DOCUMENT_CREATE_CHECK = "document_create_check"
+    DOCUMENT_MODIFY_CHECK = "document_modify_check"
+    PART_CREATE_CHECK = "part_create_check"
+    PART_MODIFY_CHECK = "part_modify_check"
 
 
 class BaseEvent(BaseModel):

csfunctions/events/document_create_check.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 DocumentCreateCheckData(BaseModel):
+    documents: list[Document] = Field(..., description="List of documents that are about to be created")
+    attached_parts: list[Part] = Field(..., description="List of parts that belong to the documents")
+    attached_documents: list[Document] = Field(
+        ..., description="Contains the original document(s) if a document is a copy"
+    )
+
+
+class DocumentCreateCheckEvent(BaseEvent):
+    name: Literal[EventNames.DOCUMENT_CREATE_CHECK] = EventNames.DOCUMENT_CREATE_CHECK
+    data: DocumentCreateCheckData

csfunctions/events/document_modify_check.py

@@ -0,0 +1,17 @@
+from typing import Literal
+
+from pydantic import BaseModel, Field
+
+from csfunctions.objects import Document, Part
+
+from .base import BaseEvent, EventNames
+
+
+class DocumentModifyCheckData(BaseModel):
+    documents: list[Document] = Field(..., description="List of documents that are about to be modified")
+    attached_parts: list[Part] = Field(..., description="List of parts that belong to the documents")
+
+
+class DocumentModifyCheckEvent(BaseEvent):
+    name: Literal[EventNames.DOCUMENT_MODIFY_CHECK] = EventNames.DOCUMENT_MODIFY_CHECK
+    data: DocumentModifyCheckData

csfunctions/events/part_create_check.py

@@ -0,0 +1,17 @@
+from typing import Literal
+
+from pydantic import BaseModel, Field
+
+from csfunctions.objects import Document, Part
+
+from .base import BaseEvent, EventNames
+
+
+class PartCreateCheckData(BaseModel):
+    parts: list[Part] = Field(..., description="List of parts that are about to be created")
+    attached_documents: list[Document] = Field(..., description="Contains the original part(s) if a part is a copy")
+
+
+class PartCreateCheckEvent(BaseEvent):
+    name: Literal[EventNames.PART_CREATE_CHECK] = EventNames.PART_CREATE_CHECK
+    data: PartCreateCheckData

csfunctions/events/part_modify_check.py

@@ -0,0 +1,16 @@
+from typing import Literal
+
+from pydantic import BaseModel, Field
+
+from csfunctions.objects import Part
+
+from .base import BaseEvent, EventNames
+
+
+class PartModifyCheckData(BaseModel):
+    parts: list[Part] = Field(..., description="List of parts that are about to be modified")
+
+
+class PartModifyCheckEvent(BaseEvent):
+    name: Literal[EventNames.PART_MODIFY_CHECK] = EventNames.PART_MODIFY_CHECK
+    data: PartModifyCheckData