[#5074] Transform selectboxes data to list for JSON dump

Author: vaszig

src/openforms/js/components/admin/form_design/registrations/json_dump/JSONDumpOptionsForm.js

@@ -58,6 +58,7 @@ const JSONDumpOptionsForm = ({name, label, schema, formData, onChange}) => {
         variables: [],
         fixedMetadataVariables: fixedMetadataVariables || [],
         additionalMetadataVariables: [],
+        transformToList: [],
         ...formData,
       }}
       onSubmit={values => onChange({formData: values})}

src/openforms/js/components/admin/form_design/registrations/json_dump/JSONDumpVariableConfigurationEditor.js

@@ -1,22 +1,32 @@
 import {useFormikContext} from 'formik';
 import PropTypes from 'prop-types';
-import React from 'react';
+import React, {useContext} from 'react';
 import {FormattedMessage} from 'react-intl';
 
+import {FormContext} from 'components/admin/form_design/Context';
 import {VARIABLE_SOURCES} from 'components/admin/form_design/variables/constants';
 import {getVariableSource} from 'components/admin/form_design/variables/utils';
 import Field from 'components/admin/forms/Field';
 import FormRow from 'components/admin/forms/FormRow';
 import {Checkbox} from 'components/admin/forms/Inputs';
 
+import {CUSTOM_COMPONENTS_SCHEMA} from '../utils';
+
 const JSONDumpVariableConfigurationEditor = ({variable}) => {
   const {
-    values: {variables = [], additionalMetadataVariables = [], fixedMetadataVariables = []},
+    values: {
+      variables = [],
+      additionalMetadataVariables = [],
+      fixedMetadataVariables = [],
+      transformToList = [],
+    },
     setFieldValue,
   } = useFormikContext();
+  const {components} = useContext(FormContext);
   const isIncluded = variables.includes(variable.key);
   const isRequiredInMetadata = fixedMetadataVariables.includes(variable.key);
   const isInAdditionalMetadata = additionalMetadataVariables.includes(variable.key);
+  const componentType = components[variable?.key]?.type;
 
   return (
     <>
@@ -78,6 +88,37 @@ const JSONDumpVariableConfigurationEditor = ({variable}) => {
           />
         </Field>
       </FormRow>
+
+      {componentType in CUSTOM_COMPONENTS_SCHEMA && (
+        <FormRow>
+          <Field name={`transformToList.${variable.key}`}>
+            <Checkbox
+              name="transformToListCheckbox"
+              label={
+                <FormattedMessage
+                  defaultMessage="Transform to list"
+                  description="'Transform to list' checkbox label"
+                />
+              }
+              helpText={
+                <FormattedMessage
+                  description="'Transform to list' checkbox help text"
+                  defaultMessage="Whether to transform the data of the component to a list or not (depends on the component type)"
+                />
+              }
+              checked={transformToList.includes(variable.key) || false}
+              onChange={event => {
+                const shouldBeTransformed = event.target.checked;
+                const newTransformToList = shouldBeTransformed
+                  ? [...transformToList, variable.key]
+                  : transformToList.filter(key => key !== variable.key);
+                setFieldValue('transformToList', newTransformToList);
+                setFieldValue(`transformToList.${variable.key}`, event.target.checked);
+              }}
+            />
+          </Field>
+        </FormRow>
+      )}
     </>
   );
 };

src/openforms/js/components/admin/form_design/registrations/utils.js

@@ -0,0 +1,3 @@
+const CUSTOM_COMPONENTS_SCHEMA = {selectboxes: [{type: 'array'}]};
+
+export {CUSTOM_COMPONENTS_SCHEMA};

src/openforms/registrations/contrib/json_dump/config.py

@@ -1,4 +1,4 @@
-from typing import TypedDict
+from typing import NotRequired, TypedDict
 
 from django.core.exceptions import ValidationError
 from django.utils.translation import gettext_lazy as _
@@ -70,6 +70,16 @@ class JSONDumpOptionsSerializer(JsonSchemaSerializerMixin, serializers.Serialize
         required=False,
         default=list,
     )
+    transform_to_list = serializers.ListField(
+        child=FormioVariableKeyField(),
+        label=_("Transform to list"),
+        required=False,
+        default=list,
+        help_text=_(
+            "The components which need special handling concerning the shape of the "
+            "data and needs to be transformed to a list."
+        ),
+    )
 
 
 class JSONDumpOptions(TypedDict):
@@ -85,3 +95,4 @@ class JSONDumpOptions(TypedDict):
     variables: list[str]
     fixed_metadata_variables: list[str]
     additional_metadata_variables: list[str]
+    transform_to_list: NotRequired[list]

src/openforms/registrations/contrib/json_dump/plugin.py

@@ -65,7 +65,8 @@ def register_submission(
             if key in options["variables"]
         }
         values_schema = generate_json_schema(submission.form, options["variables"])
-        post_process(values, values_schema, submission)
+        transform_to_list = options.get("transform_to_list")
+        post_process(values, values_schema, submission, transform_to_list)
 
         # Metadata
         # Note: as the metadata contains only static variables no post-processing is
@@ -114,7 +115,10 @@ def get_variables(self) -> list[FormVariable]:  # pragma: no cover
 
 
 def post_process(
-    values: JSONObject, schema: JSONObject, submission: Submission
+    values: JSONObject,
+    schema: JSONObject,
+    submission: Submission,
+    transform_to_list: list | None = None,
 ) -> None:
     """Post-process the values and schema.
 
@@ -127,6 +131,8 @@ def post_process(
     :param values: Mapping from key to value of the data to be sent.
     :param schema: JSON schema describing ``values``.
     :param submission: The corresponding submission instance.
+    :param transform_to_list: The list of the variables(keys) which need special handling
+      concerning the shape of the data (need transformation to a list).
     """
     state = submission.load_submission_value_variables_state()
 
@@ -170,7 +176,12 @@ def post_process(
         assert component is not None
 
         process_component(
-            component, values, schema, attachments_dict, configuration_wrapper
+            component,
+            values,
+            schema,
+            attachments_dict,
+            configuration_wrapper,
+            transform_to_list=transform_to_list,
         )
 
 
@@ -181,6 +192,7 @@ def process_component(
     attachments: dict[str, list[SubmissionFileAttachment]],
     configuration_wrapper,
     key_prefix: str = "",
+    transform_to_list: list | None = None,
 ) -> None:
     """Process a component.
 
@@ -202,6 +214,8 @@ def process_component(
     :param key_prefix: If the component is part of an edit grid component, this key
       prefix includes the parent key and the index of the component as it appears in the
       submitted data list of that edit grid component.
+    :param transform_to_list: The list of the variables(keys) which need special handling
+      concerning the shape of the data (need transformation to a list).
     """
     key = component["key"]
 
@@ -264,6 +278,12 @@ def process_component(
             if not values[key]:
                 schema["properties"][key]["required"] = []  # type: ignore
 
+            if transform_to_list and key in transform_to_list and values[key]:
+                schema["properties"][key]["type"] = "array"  # type: ignore
+                values[key] = [
+                    option for option, is_selected in values[key].items() if is_selected  # type: ignore
+                ]
+
         case {"type": "editgrid"}:
             # Note: the schema actually only needs to be processed once for each child
             # component, but will be processed for each submitted repeating group entry