feat: add GeneratedIdElement

See: questionpy-org/questionpy-sdk#140
questionpy-org · Jan 7, 2025 · 0670b0b · 0670b0b
1 parent 9b8612f
commit 0670b0b
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/docs/qppe-server.yaml b/docs/qppe-server.yaml
@@ -1429,6 +1429,17 @@ components:
           minItems: 1
       required: [ kind, name, initial_elements, increment, elements ]
 
+    GeneratedIdElement:
+      type: object
+      description: Generates a unique ID which won't change across form saves.
+      properties:
+        kind:
+          type: string
+          enum: [ id ]
+        name:
+          $ref: "#/components/schemas/FormName"
+      required: [ kind, name ]
+
     FormElement:
       oneOf:
         - $ref: "#/components/schemas/StaticTextElement"
@@ -1440,6 +1451,7 @@ components:
         - $ref: "#/components/schemas/HiddenElement"
         - $ref: "#/components/schemas/GroupElement"
         - $ref: "#/components/schemas/RepetitionElement"
+        - $ref: "#/components/schemas/GeneratedIdElement"
 
     FormSection:
       type: object

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