feat: add GeneratedIdElement

See: questionpy-org/questionpy-sdk#140
questionpy-org · Dec 19, 2024 · 15db8d8 · 15db8d8
1 parent 9b8612f
commit 15db8d8
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/questionpy_common/elements.py b/questionpy_common/elements.py
@@ -14,6 +14,7 @@
     "CheckboxGroupElement",
     "FormElement",
     "FormSection",
+    "GeneratedIdElement",
     "GroupElement",
     "HiddenElement",
     "Option",
@@ -167,13 +168,23 @@ class RepetitionElement(_BaseElement):
     """Elements that will be repeated."""
 
 
+class GeneratedIdElement(_BaseElement):
+    """Generates a unique ID which won't change across form saves.
+
+    Useful to distinguish repetitions without relying on their index, which may change when repetitions are removed.
+    """
+
+    kind: Literal["id"] = "id"
+
+
 FormElement: TypeAlias = Annotated[
     CheckboxElement
     | CheckboxGroupElement
     | GroupElement
     | HiddenElement
     | RadioGroupElement
     | RepetitionElement
+    | GeneratedIdElement
     | SelectElement
     | StaticTextElement
     | TextInputElement