Empty value (#1654)

* Empty value fix

* Empty value fix

* Adding test cases

* Fixing package info

Author: rismehta

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/internal/form/ReservedProperties.java

@@ -74,6 +74,7 @@ private ReservedProperties() {
     public static final String PN_PLACEHOLDER = "placeholder";
     public static final String PN_READ_ONLY = "readOnly";
     public static final String PN_DEFAULT_VALUE = "default";
+    public static final String PN_EMPTY_VALUE = "fd:emptyValue";
     public static final String PN_MULTI_DEFAULT_VALUES = "fd:multiDefaultValues";
     public static final String PN_FORMAT = "format";
     public static final String PN_DISPLAY_FORMAT = "displayFormat";

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/models/form/Field.java

@@ -98,6 +98,24 @@ default Object[] getDefault() {
         return null;
     }
 
+    /**
+     * The value that represents an empty state for the field.
+     * This can be used to distinguish between null, empty string, or undefined values.
+     * 
+     * Valid values for this property are:
+     * - "null" - represents null value
+     * - "undefined" - represents undefined value
+     * - "" - represents empty string
+     * 
+     *
+     * @return empty value representation for the field
+     * @since com.adobe.cq.forms.core.components.models.form 5.12.1
+     */
+    @Nullable
+    default String getEmptyValue() {
+        return null;
+    }
+
     /**
      * The expression that when evaluated would determine what the displayValue of a field would be
      *

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/models/form/package-info.java

@@ -35,7 +35,7 @@
  * </p>
  */
 
-@Version("5.12.0")
+@Version("5.12.1")
 package com.adobe.cq.forms.core.components.models.form;
 
 import org.osgi.annotation.versioning.Version;

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/util/AbstractFieldImpl.java

@@ -38,6 +38,42 @@
  */
 public abstract class AbstractFieldImpl extends AbstractBaseImpl implements Field {
 
+    /**
+     * Enum representing the possible values for emptyValue property.
+     */
+    public static enum EmptyValue {
+        NULL("null"),
+        UNDEFINED("undefined"),
+        EMPTY_STRING("");
+
+        private final String value;
+
+        EmptyValue(String value) {
+            this.value = value;
+        }
+
+        public String getValue() {
+            return value;
+        }
+
+        /**
+         * Converts a string value to EmptyValue enum.
+         * Returns EMPTY_STRING for any unrecognized values.
+         */
+        public static EmptyValue fromString(String value) {
+            if (value == null) {
+                return null;
+            }
+            for (EmptyValue emptyValue : EmptyValue.values()) {
+                if (emptyValue.getValue().equals(value)) {
+                    return emptyValue;
+                }
+            }
+            // Default to empty string for any unrecognized values
+            return EMPTY_STRING;
+        }
+    }
+
     private static final Logger logger = LoggerFactory.getLogger(AbstractFieldImpl.class);
 
     @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL, name = ReservedProperties.PN_READ_ONLY)
@@ -49,6 +85,11 @@ public abstract class AbstractFieldImpl extends AbstractBaseImpl implements Fiel
     @Nullable
     protected Object[] defaultValue;
 
+    @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL, name = ReservedProperties.PN_EMPTY_VALUE)
+    @Nullable
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    protected String emptyValue;
+
     @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL, name = ReservedProperties.PN_PLACEHOLDER)
     @Nullable
     protected String placeholder;
@@ -160,6 +201,16 @@ public Object[] getDefault() {
         return null;
     }
 
+    @Override
+    @Nullable
+    public String getEmptyValue() {
+        if (emptyValue == null) {
+            return null;
+        }
+        EmptyValue enumValue = EmptyValue.fromString(emptyValue);
+        return enumValue != null ? enumValue.getValue() : EmptyValue.EMPTY_STRING.getValue();
+    }
+
     @Override
     @Nullable
     public String getPlaceHolder() {

bundles/af-core/src/test/java/com/adobe/cq/forms/core/components/internal/models/v1/form/TextInputImplTest.java

@@ -32,6 +32,7 @@
 import com.adobe.cq.forms.core.components.datalayer.FormComponentData;
 import com.adobe.cq.forms.core.components.internal.form.FormConstants;
 import com.adobe.cq.forms.core.components.models.form.*;
+import com.adobe.cq.forms.core.components.util.AbstractFieldImpl;
 import com.adobe.cq.forms.core.components.util.AbstractFormComponentImpl;
 import com.adobe.cq.forms.core.context.FormsCoreComponentTestContext;
 import com.adobe.cq.wcm.style.ComponentStyleInfo;
@@ -64,6 +65,11 @@ public class TextInputImplTest {
     private static final String PATH_TEXTINPUT_PLACEHOLDER_AUTOCOMPLETE = CONTENT_ROOT + "/textinput-placeholder-autocomplete";
     private static final String PATH_TEXTINPUT_WITH_VIEWTYPE = CONTENT_ROOT + "/textinput-with-viewtype";
     private static final String PATH_TEXTINPUT_WITHOUT_FIELDTYPE = CONTENT_ROOT + "/textinput-without-fieldtype";
+    private static final String PATH_TEXTINPUT_EMPTYVALUE_NULL = CONTENT_ROOT + "/textinput-emptyvalue-null";
+    private static final String PATH_TEXTINPUT_EMPTYVALUE_UNDEFINED = CONTENT_ROOT + "/textinput-emptyvalue-undefined";
+    private static final String PATH_TEXTINPUT_EMPTYVALUE_EMPTY_STRING = CONTENT_ROOT + "/textinput-emptyvalue-empty-string";
+    private static final String PATH_TEXTINPUT_EMPTYVALUE_INVALID = CONTENT_ROOT + "/textinput-emptyvalue-invalid";
+    private static final String PATH_TEXTINPUT_EMPTYVALUE_NOT_SET = CONTENT_ROOT + "/textinput-emptyvalue-not-set";
 
     private final AemContext context = FormsCoreComponentTestContext.newAemContext();
 
@@ -517,4 +523,57 @@ void testNoFieldType() {
         TextInput textInput = Utils.getComponentUnderTest(PATH_TEXTINPUT_WITHOUT_FIELDTYPE, TextInput.class, context);
         assertEquals(FieldType.TEXT_INPUT.getValue(), textInput.getFieldType());
     }
+
+    @Test
+    void testEmptyValueNull() {
+        TextInput textInput = Utils.getComponentUnderTest(PATH_TEXTINPUT_EMPTYVALUE_NULL, TextInput.class, context);
+        assertEquals("null", textInput.getEmptyValue());
+    }
+
+    @Test
+    void testEmptyValueUndefined() {
+        TextInput textInput = Utils.getComponentUnderTest(PATH_TEXTINPUT_EMPTYVALUE_UNDEFINED, TextInput.class, context);
+        assertEquals("undefined", textInput.getEmptyValue());
+    }
+
+    @Test
+    void testEmptyValueEmptyString() {
+        TextInput textInput = Utils.getComponentUnderTest(PATH_TEXTINPUT_EMPTYVALUE_EMPTY_STRING, TextInput.class, context);
+        assertEquals("", textInput.getEmptyValue());
+    }
+
+    @Test
+    void testEmptyValueInvalidDefaultsToEmptyString() {
+        TextInput textInput = Utils.getComponentUnderTest(PATH_TEXTINPUT_EMPTYVALUE_INVALID, TextInput.class, context);
+        assertEquals("", textInput.getEmptyValue()); // Should default to empty string for invalid values
+    }
+
+    @Test
+    void testEmptyValueNotSet() {
+        TextInput textInput = Utils.getComponentUnderTest(PATH_TEXTINPUT_EMPTYVALUE_NOT_SET, TextInput.class, context);
+        assertEquals(null, textInput.getEmptyValue()); // Should return null when property is not set
+    }
+
+    @Test
+    void testEmptyValueEnumFromString() {
+        // Test the enum's fromString method directly
+        assertEquals(AbstractFieldImpl.EmptyValue.NULL,
+            AbstractFieldImpl.EmptyValue.fromString("null"));
+        assertEquals(AbstractFieldImpl.EmptyValue.UNDEFINED,
+            AbstractFieldImpl.EmptyValue.fromString("undefined"));
+        assertEquals(AbstractFieldImpl.EmptyValue.EMPTY_STRING,
+            AbstractFieldImpl.EmptyValue.fromString(""));
+        assertEquals(AbstractFieldImpl.EmptyValue.EMPTY_STRING,
+            AbstractFieldImpl.EmptyValue.fromString("invalid-value"));
+        assertEquals(null,
+            AbstractFieldImpl.EmptyValue.fromString(null));
+    }
+
+    @Test
+    void testEmptyValueEnumGetValue() {
+        // Test the enum's getValue method
+        assertEquals("null", AbstractFieldImpl.EmptyValue.NULL.getValue());
+        assertEquals("undefined", AbstractFieldImpl.EmptyValue.UNDEFINED.getValue());
+        assertEquals("", AbstractFieldImpl.EmptyValue.EMPTY_STRING.getValue());
+    }
 }

bundles/af-core/src/test/resources/form/textinput/exporter-textinput-format.json

@@ -11,6 +11,7 @@
   "constraintMessages": {
     "type": "incorrect type"
   },
+  "emptyValue": "null",
   "readOnly": false,
   "format": "email",
   "default": "abc",

bundles/af-core/src/test/resources/form/textinput/test-content.json

@@ -111,7 +111,8 @@
     "fieldType": "text-input",
     "readOnly": false,
     "enabled": true,
-    "format" : "email"
+    "format" : "email",
+    "fd:emptyValue" : "null"
   },
   "textinput-datalayer" : {
     "sling:resourceType"    : "core/fd/components/form/textinput/v1/textinput",
@@ -202,5 +203,39 @@
     "jcr:title" : "def",
     "placeholder": "test-placeholder",
     "fd:viewType": "some/custom/value"
+  },
+  "textinput-emptyvalue-null" : {
+    "jcr:primaryType": "nt:unstructured",
+    "sling:resourceType"    : "core/fd/components/form/textinput/v1/textinput",
+    "name" : "abc",
+    "jcr:title" : "def",
+    "fd:emptyValue": "null"
+  },
+  "textinput-emptyvalue-undefined" : {
+    "jcr:primaryType": "nt:unstructured",
+    "sling:resourceType"    : "core/fd/components/form/textinput/v1/textinput",
+    "name" : "abc",
+    "jcr:title" : "def",
+    "fd:emptyValue": "undefined"
+  },
+  "textinput-emptyvalue-empty-string" : {
+    "jcr:primaryType": "nt:unstructured",
+    "sling:resourceType"    : "core/fd/components/form/textinput/v1/textinput",
+    "name" : "abc",
+    "jcr:title" : "def",
+    "fd:emptyValue": ""
+  },
+  "textinput-emptyvalue-invalid" : {
+    "jcr:primaryType": "nt:unstructured",
+    "sling:resourceType"    : "core/fd/components/form/textinput/v1/textinput",
+    "name" : "abc",
+    "jcr:title" : "def",
+    "fd:emptyValue": "invalid-value"
+  },
+  "textinput-emptyvalue-not-set" : {
+    "jcr:primaryType": "nt:unstructured",
+    "sling:resourceType"    : "core/fd/components/form/textinput/v1/textinput",
+    "name" : "abc",
+    "jcr:title" : "def"
   }
 }