From 4ddc7f30fcd149bbbc7cc84294263531f5e28616 Mon Sep 17 00:00:00 2001
From: Viktor van Wijk <viktorvanwijk@hotmail.com>
Date: Mon, 23 Dec 2024 17:02:57 +0100
Subject: [PATCH] :sparkles: [#4908] Add checkbox to include variables from the
 variable table

---
 .../admin/form_design/registrations/index.js  | 11 ++-
 .../registrations/json/JSONSummaryHandler.js  | 32 +++++++++
 .../json/JSONVariableConfigurationEditor.js   | 69 +++++++++++++++++++
 3 files changed, 110 insertions(+), 2 deletions(-)
 create mode 100644 src/openforms/js/components/admin/form_design/registrations/json/JSONSummaryHandler.js
 create mode 100644 src/openforms/js/components/admin/form_design/registrations/json/JSONVariableConfigurationEditor.js

diff --git a/src/openforms/js/components/admin/form_design/registrations/index.js b/src/openforms/js/components/admin/form_design/registrations/index.js
index 4c549674ee..9a973dc8f7 100644
--- a/src/openforms/js/components/admin/form_design/registrations/index.js
+++ b/src/openforms/js/components/admin/form_design/registrations/index.js
@@ -1,7 +1,9 @@
 import CamundaOptionsForm from './camunda';
 import DemoOptionsForm from './demo';
 import EmailOptionsForm from './email';
-import JSONOptionsForm from './json';
+import JSONOptionsForm from './json/JSONOptionsForm';
+import JSONSummaryHandler from './json/JSONSummaryHandler';
+import JSONVariableConfigurationEditor from './json/JSONVariableConfigurationEditor';
 import MSGraphOptionsForm from './ms_graph';
 import ObjectsApiOptionsForm from './objectsapi/ObjectsApiOptionsForm';
 import ObjectsApiSummaryHandler from './objectsapi/ObjectsApiSummaryHandler';
@@ -47,7 +49,12 @@ export const BACKEND_OPTIONS_FORMS = {
     form: StufZDSOptionsForm,
   },
   'microsoft-graph': {form: MSGraphOptionsForm},
-  'json': {form: JSONOptionsForm},
+  'json': {
+    form: JSONOptionsForm,
+    configurableFromVariables: true,
+    summaryHandler: JSONSummaryHandler,
+    variableConfigurationEditor: JSONVariableConfigurationEditor,
+  },
   // demo plugins
   demo: {form: DemoOptionsForm},
   'failing-demo': {form: DemoOptionsForm},
diff --git a/src/openforms/js/components/admin/form_design/registrations/json/JSONSummaryHandler.js b/src/openforms/js/components/admin/form_design/registrations/json/JSONSummaryHandler.js
new file mode 100644
index 0000000000..28878d65ac
--- /dev/null
+++ b/src/openforms/js/components/admin/form_design/registrations/json/JSONSummaryHandler.js
@@ -0,0 +1,32 @@
+import {FormattedMessage} from 'react-intl';
+import React from 'react';
+
+const JSONSummaryHandler = ({variable, backendOptions}) => {
+
+  const isIncluded = backendOptions.formVariables.includes(variable.key);
+
+  if (isIncluded) {
+    return (
+      <FormattedMessage
+        description="JSON registration summary message"
+        defaultMessage="Included"
+      />
+    );
+  }
+  else {
+    return (
+      <FormattedMessage
+        description="JSON registration summary message"
+        defaultMessage="Not included"
+      />
+    );
+  }
+};
+
+
+// TODO-4098: ??
+JSONSummaryHandler.propTypes = {
+
+};
+
+export default JSONSummaryHandler;
diff --git a/src/openforms/js/components/admin/form_design/registrations/json/JSONVariableConfigurationEditor.js b/src/openforms/js/components/admin/form_design/registrations/json/JSONVariableConfigurationEditor.js
new file mode 100644
index 0000000000..2c89090183
--- /dev/null
+++ b/src/openforms/js/components/admin/form_design/registrations/json/JSONVariableConfigurationEditor.js
@@ -0,0 +1,69 @@
+// TODO-4908: fix imports
+import {Checkbox} from 'components/admin/forms/Inputs';
+import Field from '../../../forms/Field';
+import {FormattedMessage} from 'react-intl';
+import FormRow from '../../../forms/FormRow';
+import React from 'react';
+import {useField, useFormikContext} from 'formik';
+import PropTypes from 'prop-types';
+
+
+const JSONVariableConfigurationEditor = ({variable}) => {
+  const [fieldProps, , fieldHelpers] = useField('formVariables');
+  const {setValue} = fieldHelpers;
+
+  const formVariables = fieldProps.value
+  const isIncluded = formVariables.includes(variable.key);
+
+  return (
+    <FormRow>
+      <Field name="includeVariable">
+        <Checkbox
+          name="includeVariableCheckbox"
+          label={
+            <FormattedMessage
+              description="'Include variable' checkbox label"
+              defaultMessage="Include variable"
+            />
+          }
+          helpText={
+            <FormattedMessage
+              description="'Include variable' checkbox help text"
+              defaultMessage="Whether to include this variable in the data to be sent."
+            />
+          }
+          checked={isIncluded}
+          onChange={event => {
+            const formVariablesNew = formVariables.slice();
+            const index = formVariablesNew.indexOf(variable.key);
+            if (event.target.checked) {
+              // TODO-4908: remove this when testing is implemented
+              if (index !== -1) {throw new Error(
+                "This form variable is already on the list of " +
+                "form variables to include. This shouldn't happen"
+              );}
+              formVariablesNew.push(variable.key);
+            } else {
+              if (index === -1) {throw new Error(
+                "This form variable is not yet on the list of " +
+                "form variables to include. This shouldn't happen."
+              );}
+              formVariablesNew.splice(index, 1);
+            }
+            setValue(formVariablesNew);
+          }}
+        />
+      </Field>
+    </FormRow>
+  )
+}
+
+// TODO-4098: ???
+JSONVariableConfigurationEditor.propTypes = {
+  variable: PropTypes.shape({
+    key: PropTypes.string.isRequired,
+  }).isRequired,
+};
+
+
+export default JSONVariableConfigurationEditor