🏷️ [#4689] Fix type definitions / add type definitions

Fixed/added some type definitions to make it easier to reason about
the data being operated on.

src/openforms/formio/typing/__init__.py

@@ -16,6 +16,7 @@
     EditGridComponent,
     FieldsetComponent,
     FileComponent,
+    FileValue,
     RadioComponent,
     SelectBoxesComponent,
     SelectComponent,
@@ -31,6 +32,7 @@
     "TextFieldComponent",
     "DateComponent",
     "DatetimeComponent",
+    "FileValue",
     "FileComponent",
     "SelectComponent",
     "SelectBoxesComponent",

src/openforms/formio/typing/vanilla.py

@@ -22,6 +22,29 @@ class FileComponent(Component):
     maxNumberOfFiles: NotRequired[int]
 
 
+class FileData(TypedDict):
+    url: str
+    form: Literal[""]
+    name: str
+    size: int
+    baseUrl: str
+    project: Literal[""]
+
+
+class SingleFileValue(TypedDict):
+    # Source of truth: https://github.com/open-formulieren/types/blob/main/src/formio/components/file.ts
+    name: str
+    originalName: str
+    size: int
+    storage: Literal["url"]
+    type: str
+    url: str
+    data: FileData
+
+
+type FileValue = list[SingleFileValue]
+
+
 class SelectData(TypedDict, total=False):
     values: list[OptionDict]
 

src/openforms/typing.py

@@ -3,7 +3,7 @@
 import datetime
 import decimal
 import uuid
-from typing import TYPE_CHECKING, Any, NewType, Protocol
+from typing import TYPE_CHECKING, Any, NewType, Protocol, Sequence
 
 from django.http import HttpRequest
 from django.http.response import HttpResponseBase
@@ -18,7 +18,7 @@
 
 type JSONPrimitive = str | int | float | bool | None
 
-type JSONValue = JSONPrimitive | JSONObject | list[JSONValue]
+type JSONValue = JSONPrimitive | JSONObject | Sequence[JSONValue]
 
 type JSONObject = dict[str, JSONValue]