Theme editor changes for Core Components

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/internal/constants/ThemeConstants.java

@@ -0,0 +1,26 @@
+package com.adobe.cq.forms.core.components.internal.constants;
+
+/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  ~ Copyright 2024 Adobe
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~     http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
+
+public class ThemeConstants {
+
+    public static final String RELATIVE_PATH_METADATA = "/metadata";
+    public static final String THEME_OVERRIDE = "themeOverride";
+    public static final String THEME_REF = "themeRef";
+    public static final String PROPERTY_CLIENTLIB_CATEGORY = "clientlibCategory";
+
+}

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

@@ -18,8 +18,10 @@
 import java.io.StringWriter;
 import java.io.Writer;
 
+import org.apache.commons.lang3.StringUtils;
 import org.apache.sling.api.SlingHttpServletRequest;
 import org.apache.sling.api.resource.Resource;
+import org.apache.sling.api.resource.ValueMap;
 import org.apache.sling.models.annotations.Model;
 import org.apache.sling.models.annotations.injectorspecific.InjectionStrategy;
 import org.apache.sling.models.annotations.injectorspecific.SlingObject;
@@ -28,6 +30,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.adobe.cq.forms.core.components.internal.constants.ThemeConstants;
 import com.adobe.cq.forms.core.components.models.form.FormContainer;
 import com.adobe.cq.forms.core.components.models.form.FormStructureParser;
 import com.adobe.cq.forms.core.components.models.form.HtlUtil;
@@ -60,6 +63,36 @@ public String getClientLibRefFromFormContainer() {
         return getPropertyFromFormContainer(resource, FormContainer.PN_CLIENT_LIB_REF);
     }
 
+    @Override
+    public String getThemeClientLibRefFromFormContainer() {
+        String themeContentPath = null;
+        String themeClientLibRef = null;
+        if (request != null) {
+            themeContentPath = (String) request.getAttribute(ThemeConstants.THEME_OVERRIDE); // theme editor use-case
+        }
+        if (StringUtils.isBlank(themeContentPath)) {
+            if (request != null) {
+                themeContentPath = request.getParameter(ThemeConstants.THEME_OVERRIDE); // embed component use-case
+            }
+            if (StringUtils.isBlank(themeContentPath)) {
+                themeContentPath = getPropertyFromFormContainer(resource, ThemeConstants.THEME_REF); // normal including theme in form
+                                                                                                     // runtime
+            }
+        }
+        // get client library from theme content path
+        if (StringUtils.isNotBlank(themeContentPath)) {
+            Resource themeResource = resource.getResourceResolver().getResource(themeContentPath + ThemeConstants.RELATIVE_PATH_METADATA);
+            if (themeResource != null) {
+                ValueMap themeProps = themeResource.getValueMap();
+                themeClientLibRef = themeProps.get(ThemeConstants.PROPERTY_CLIENTLIB_CATEGORY, "");
+            } else {
+                logger.error("Invalid Theme Name {}", themeContentPath);
+            }
+        }
+
+        return themeClientLibRef;
+    }
+
     @Override
     public Boolean containsFormContainer() {
         return containsFormContainer(resource);

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

@@ -37,6 +37,12 @@ public interface FormStructureParser {
      */
     String getClientLibRefFromFormContainer();
 
+    /**
+     *
+     * @returns reference to the client lib of the theme from form container
+     */
+    String getThemeClientLibRefFromFormContainer();
+
     /**
      * Checks if this resource contains a form container
      *

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

@@ -28,6 +28,7 @@
 import org.junit.jupiter.api.extension.ExtendWith;
 
 import com.adobe.cq.export.json.SlingModelFilter;
+import com.adobe.cq.forms.core.components.internal.constants.ThemeConstants;
 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.context.FormsCoreComponentTestContext;
@@ -179,6 +180,67 @@ public void containsFormContainer_should_return_false() {
         assertFalse(result);
     }
 
+    @Test
+    void testGetThemeClientLibRefFromFormContainer() {
+        String path = CONTENT_ROOT + "/myTestPage";
+        FormStructureParser formStructureParser = getFormStructureParserUnderTest(path);
+        String themeClientLibRef = formStructureParser.getThemeClientLibRefFromFormContainer();
+        assertEquals("fdtheme.test-theme", themeClientLibRef);
+    }
+
+    @Test
+    void testGetThemeClientLibRefWithRequestAttribute() {
+        String path = CONTENT_ROOT + "/myTestPage";
+        context.currentResource(path);
+        MockSlingHttpServletRequest request = context.request();
+        request.setAttribute(ThemeConstants.THEME_OVERRIDE, "/content/dam/formsanddocuments-themes/test-theme");
+        FormStructureParser formStructureParser = request.adaptTo(FormStructureParser.class);
+        String themeClientLibRef = formStructureParser.getThemeClientLibRefFromFormContainer();
+        assertEquals("fdtheme.test-theme", themeClientLibRef);
+    }
+
+    @Test
+    void testGetThemeClientLibRefWithRequestParameter() {
+        String path = CONTENT_ROOT + "/myTestPage";
+        context.currentResource(path);
+        MockSlingHttpServletRequest request = context.request();
+        request.setParameterMap(Collections.singletonMap(ThemeConstants.THEME_OVERRIDE,
+            "/content/dam/formsanddocuments-themes/test-theme"));
+        FormStructureParser formStructureParser = request.adaptTo(FormStructureParser.class);
+        String themeClientLibRef = formStructureParser.getThemeClientLibRefFromFormContainer();
+        assertEquals("fdtheme.test-theme", themeClientLibRef);
+    }
+
+    @Test
+    void testGetThemeClientLibRefWithInvalidThemePath() {
+        String path = CONTENT_ROOT + "/myTestPage";
+        context.currentResource(path);
+        MockSlingHttpServletRequest request = context.request();
+        request.setAttribute(ThemeConstants.THEME_OVERRIDE, "/content/dam/formsanddocuments-themes/invalid-theme");
+        FormStructureParser formStructureParser = request.adaptTo(FormStructureParser.class);
+        String themeClientLibRef = formStructureParser.getThemeClientLibRefFromFormContainer();
+        assertNull(themeClientLibRef);
+    }
+
+    @Test
+    void testGetThemeClientLibRefWithNonExistentTheme() {
+        String path = CONTENT_ROOT + "/myTestPage";
+        context.currentResource(path);
+        MockSlingHttpServletRequest request = context.request();
+        request.setAttribute(ThemeConstants.THEME_OVERRIDE, "/content/dam/formsanddocuments-themes/non-existent");
+        FormStructureParser formStructureParser = request.adaptTo(FormStructureParser.class);
+        String themeClientLibRef = formStructureParser.getThemeClientLibRefFromFormContainer();
+        assertNull(themeClientLibRef);
+    }
+
+    @Test
+    void testGetThemeClientLibRefWithoutTheme() {
+        String path = FORM_CONTAINER_PATH + "/container1";
+        FormStructureParser formStructureParser = getFormStructureParserUnderTest(path);
+        String themeClientLibRef = formStructureParser.getThemeClientLibRefFromFormContainer();
+        assertNull(themeClientLibRef);
+    }
+
     private FormStructureParser getFormStructureParserUnderTest(String resourcePath) {
         context.currentResource(resourcePath);
         MockSlingHttpServletRequest request = context.request();

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

@@ -14,6 +14,7 @@
         "thankyouPage": "/a/b/c",
         "thankyouMessage": "message",
         "clientLibRef" : "abc",
+        "themeRef": "/content/dam/formsanddocuments-themes/test-theme",
         "datepicker": {
           "jcr:primaryType": "nt:unstructured",
           "sling:resourceType": "core/fd/components/form/datepicker/v1/datepicker",
@@ -88,5 +89,27 @@
         }
       }
     }
+  },
+  "dam": {
+    "jcr:primaryType": "nt:unstructured",
+    "formsanddocuments-themes": {
+      "jcr:primaryType": "nt:unstructured",
+      "test-theme": {
+        "jcr:primaryType": "nt:unstructured",
+        "jcr:content": {
+          "jcr:primaryType": "dam:AssetContent",
+          "metadata": {
+            "jcr:primaryType": "nt:unstructured",
+            "clientlibCategory": "fdtheme.test-theme"
+          }
+        }
+      },
+      "invalid-theme": {
+        "jcr:primaryType": "nt:unstructured",
+        "jcr:content": {
+          "jcr:primaryType": "dam:AssetContent"
+        }
+      }
+    }
   }
 }