feat: document field calculation event

Author: Jens Kürten

csfunctions/events/__init__.py

@@ -3,6 +3,7 @@
 from pydantic import Field
 
 from .dialog_data import DocumentReleaseDialogData, PartReleaseDialogData
+from .document_field_calculation import DocumentFieldCalculationData, DocumentFieldCalculationEvent
 from .document_release import DocumentReleaseData, DocumentReleaseEvent
 from .document_release_check import DocumentReleaseCheckData, DocumentReleaseCheckEvent
 from .dummy import DummyEvent, DummyEventData
@@ -17,6 +18,7 @@
     Union[
         DocumentReleaseEvent,
         DocumentReleaseCheckEvent,
+        DocumentFieldCalculationEvent,
         PartReleaseEvent,
         PartReleaseCheckEvent,
         FieldValueCalculationEvent,
@@ -30,6 +32,7 @@
 EventData = Union[
     DocumentReleaseData,
     DocumentReleaseCheckData,
+    DocumentFieldCalculationData,
     PartReleaseData,
     PartReleaseCheckData,
     FieldValueCalculationData,
@@ -42,6 +45,7 @@
 __all__ = [
     "DocumentReleaseEvent",
     "DocumentReleaseCheckEvent",
+    "DocumentFieldCalculationEvent",
     "PartReleaseEvent",
     "PartReleaseCheckEvent",
     "FieldValueCalculationEvent",
@@ -51,6 +55,7 @@
     "WorkflowTaskTriggerEvent",
     "DocumentReleaseData",
     "DocumentReleaseCheckData",
+    "DocumentFieldCalculationData",
     "PartReleaseData",
     "PartReleaseCheckData",
     "FieldValueCalculationData",

csfunctions/events/base.py

@@ -7,6 +7,7 @@ class EventNames(str, Enum):
     DUMMY = "dummy"
     DOCUMENT_RELEASE = "document_release"
     DOCUMENT_RELEASE_CHECK = "document_release_check"
+    DOCUMENT_FIELD_CALCULATION = "document_field_calculation"
     PART_RELEASE = "part_release"
     PART_RELEASE_CHECK = "part_release_check"
     ENGINEERING_CHANGE_RELEASE = "engineering_change_release"

csfunctions/events/document_field_calculation.py

@@ -0,0 +1,19 @@
+from typing import Literal
+
+from pydantic import BaseModel, Field
+
+from csfunctions.objects import Document, Part
+
+from .base import BaseEvent, EventNames
+
+
+class DocumentFieldCalculationData(BaseModel):
+    document: Document = Field(..., description="Current state of the document")
+    action: Literal["create", "modify", "copy", "index"] = Field(..., description="Action being performed")
+    linked_parts: list[Part] = Field(..., description="Parts that belong to the document")
+    linked_documents: list[Document] = Field(..., description="Related documents (e.g. source document)")
+
+
+class DocumentFieldCalculationEvent(BaseEvent):
+    name: Literal[EventNames.DOCUMENT_FIELD_CALCULATION] = EventNames.DOCUMENT_FIELD_CALCULATION
+    data: DocumentFieldCalculationData

json_schemas/request.json

@@ -731,6 +731,73 @@
       "title": "Document",
       "type": "object"
     },
+    "DocumentFieldCalculationData": {
+      "properties": {
+        "document": {
+          "$ref": "#/$defs/Document",
+          "description": "Current state of the document"
+        },
+        "action": {
+          "description": "Action being performed",
+          "enum": [
+            "create",
+            "modify",
+            "copy",
+            "index"
+          ],
+          "title": "Action",
+          "type": "string"
+        },
+        "linked_parts": {
+          "description": "Parts that belong to the document",
+          "items": {
+            "$ref": "#/$defs/Part"
+          },
+          "title": "Linked Parts",
+          "type": "array"
+        },
+        "linked_documents": {
+          "description": "Related documents (e.g. source document)",
+          "items": {
+            "$ref": "#/$defs/Document"
+          },
+          "title": "Linked Documents",
+          "type": "array"
+        }
+      },
+      "required": [
+        "document",
+        "action",
+        "linked_parts",
+        "linked_documents"
+      ],
+      "title": "DocumentFieldCalculationData",
+      "type": "object"
+    },
+    "DocumentFieldCalculationEvent": {
+      "properties": {
+        "name": {
+          "const": "document_field_calculation",
+          "default": "document_field_calculation",
+          "title": "Name",
+          "type": "string"
+        },
+        "event_id": {
+          "description": "unique identifier",
+          "title": "Event Id",
+          "type": "string"
+        },
+        "data": {
+          "$ref": "#/$defs/DocumentFieldCalculationData"
+        }
+      },
+      "required": [
+        "event_id",
+        "data"
+      ],
+      "title": "DocumentFieldCalculationEvent",
+      "type": "object"
+    },
     "DocumentReleaseCheckData": {
       "properties": {
         "documents": {
@@ -2749,6 +2816,7 @@
     "event": {
       "discriminator": {
         "mapping": {
+          "document_field_calculation": "#/$defs/DocumentFieldCalculationEvent",
           "document_release": "#/$defs/DocumentReleaseEvent",
           "document_release_check": "#/$defs/DocumentReleaseCheckEvent",
           "dummy": "#/$defs/DummyEvent",
@@ -2768,6 +2836,9 @@
         {
           "$ref": "#/$defs/DocumentReleaseCheckEvent"
         },
+        {
+          "$ref": "#/$defs/DocumentFieldCalculationEvent"
+        },
         {
           "$ref": "#/$defs/PartReleaseEvent"
         },