Theme editor changes

.circleci/ci/it-tests.js

@@ -39,7 +39,7 @@ try {
 
     //todo: remove this later, once aem image is released, since sites rotary aem base image has "2.25.4"
     //let wcmVersion = ci.sh('mvn help:evaluate -Dexpression=core.wcm.components.version -q -DforceStdout', true);
-    let wcmVersion = "2.26.0";
+    let wcmVersion = "2.27.0";
     ci.stage("Integration Tests");
     ci.dir(qpPath, () => {
         // Connect to QP

.circleci/docker-compose.yml

@@ -6,7 +6,7 @@ services:
     entrypoint: tail -f /dev/null  # Keeps the container running
 
   circleci-aem-cloudready:
-    image: docker-adobe-cif-release.dr-uw2.adobeitc.com/circleci-aem-cloudready:17689-rel-openjdk11
+    image: docker-adobe-cif-release.dr-uw2.adobeitc.com/circleci-aem-cloudready:c3484b0d7a-openjdk11
     depends_on:
       - circleci-qp
     # Add any additional configurations or environment variables if needed

.github/workflows/exporter-validate-pr.yml

@@ -34,8 +34,8 @@ jobs:
             head_file=$(git show ${{ github.head_ref }}:$file)
 
             # Compare the JSON keys
-            base_keys=$(echo "$base_file" | jq -r 'paths | map(tostring) | join(".")')
-            head_keys=$(echo "$head_file" | jq -r 'paths | map(tostring) | join(".")')
+            base_keys=$(echo "$base_file" | jq -r 'paths | map(tostring) | join(".")' | sed 's/\./\\./g')
+            head_keys=$(echo "$head_file" | jq -r 'paths | map(tostring) | join(".")' | sed 's/\./\\./g')
 
             # Check for removed keys
             removed_keys=$(comm -23 <(echo "$base_keys" | sort) <(echo "$head_keys" | sort))
@@ -45,11 +45,11 @@ jobs:
               echo "$removed_keys"
               exit 1
             fi
-            
+
             # Check for changed values
             for key in $base_keys; do
-              base_value=$(echo "$base_file" | jq -r ".$key")
-              head_value=$(echo "$head_file" | jq -r ".$key")
+              base_value=$(echo "$base_file" | jq -r --arg key "$key" '.[$key]')
+              head_value=$(echo "$head_file" | jq -r --arg key "$key" '.[$key]')
 
               if [ "$base_value" != "$head_value" ]; then
                 echo "Backward incompatibility change detected in $file. The value of key '$key' was changed from '$base_value' to '$head_value'."
@@ -59,4 +59,4 @@ jobs:
           done
 
           echo "All exporter JSON files have only additions. No backward incompatibility changes detected."
-        shell: bash
+        shell: bash

.github/workflows/spec-validate-pr.yml

@@ -13,19 +13,34 @@ jobs:
       - name: Check out code
         uses: actions/checkout@v2
 
+      - name: Validate branch names
+        id: validate
+        run: |
+          echo "Validating branch names..."
+          if ! [[ "${{ github.event.pull_request.head.ref }}" =~ ^[a-zA-Z0-9._/-]+$ ]]; then
+            echo "Invalid characters in head ref"
+            exit 1
+          fi
+          if ! [[ "${{ github.event.pull_request.base.ref }}" =~ ^[a-zA-Z0-9._/-]+$ ]]; then
+            echo "Invalid characters in base ref"
+            exit 1
+          fi
+          echo "::set-output name=head_ref::${{ github.event.pull_request.head.ref }}"
+          echo "::set-output name=base_ref::${{ github.event.pull_request.base.ref }}"
+
       - name: Fetch Base and Head References
         run: |
-          git fetch origin ${{ github.base_ref }}:${{ github.base_ref }}
-          git fetch origin ${{ github.head_ref }}:${{ github.head_ref }}
+          git fetch origin ${{ steps.validate.outputs.head_ref }}:${{ steps.validate.outputs.head_ref }}
+          git fetch origin ${{ steps.validate.outputs.base_ref }}:${{ steps.validate.outputs.base_ref }}
         if: github.event_name == 'pull_request'
 
       - name: Validate Changes and Commit Message
         run: |
           # Check for changes in specification files inside the resources folder
-          changed_files=$(git diff --name-only ${{ github.base_ref }} ${{ github.head_ref }})
+          changed_files=$(git diff --name-only ${{ steps.validate.outputs.base_ref }} ${{ steps.validate.outputs.head_ref }})
 
           # Fetch the commit messages from the PR
-          commit_messages=$(git log --pretty=oneline ${{ github.base_ref }}..${{ github.head_ref }})
+          commit_messages=$(git log --pretty=oneline ${{ steps.validate.outputs.base_ref }}..${{ steps.validate.outputs.head_ref }})
 
           # Check if any commit message contains a specific keyword or pattern (e.g., "RTC")
           if echo "$commit_messages" | grep -q 'RTC' && echo "$changed_files" | grep -E 'resources/schema/.*\.json$'; then
@@ -34,4 +49,4 @@ jobs:
             echo "Either commit message doesn't contain 'RTC' keyword or specification files haven't changed. Build failed.  Please check if your changes are working in visual rule editor"
             exit 1
           fi
-        shell: bash
+        shell: bash

.github/workflows/sync-pr.yml

@@ -19,15 +19,31 @@ jobs:
           git config --global user.email "ci-build@aemforms"
           git config --global user.name "ci-build"
 
+      - name: Validate branch names
+        id: validate
+        run: |
+          echo "Validating branch names..."
+          if ! [[ "${{ github.event.pull_request.head.ref }}" =~ ^[a-zA-Z0-9._/-]+$ ]]; then
+            echo "Invalid characters in head ref"
+            exit 1
+          fi
+          if ! [[ "${{ github.event.pull_request.base.ref }}" =~ ^[a-zA-Z0-9._/-]+$ ]]; then
+            echo "Invalid characters in base ref"
+            exit 1
+          fi
+          echo "::set-output name=head_ref::${{ github.event.pull_request.head.ref }}"
+          echo "::set-output name=base_ref::${{ github.event.pull_request.base.ref }}"
+
       - name: Sync with Base Branch
         if: ${{ github.event.pull_request.base.ref != 'master' }}
         run: |
-          git fetch origin
-          git checkout ${{ github.event.pull_request.base.ref }}
-          git pull origin ${{ github.event.pull_request.base.ref }}
-          git checkout ${{ github.event.pull_request.head.ref }}
-          git pull origin ${{ github.event.pull_request.head.ref }}
-          git rebase ${{ github.event.pull_request.base.ref }}
-          git push --force origin ${{ github.event.pull_request.head.ref }}
+          git fetch origin ${{ steps.validate.outputs.head_ref }}
+          git fetch origin ${{ steps.validate.outputs.base_ref }}
+          git checkout ${{ steps.validate.outputs.base_ref }}
+          git pull origin ${{ steps.validate.outputs.base_ref }}
+          git checkout ${{ steps.validate.outputs.head_ref }}
+          git pull origin ${{ steps.validate.outputs.head_ref }}
+          git rebase ${{ steps.validate.outputs.base_ref }}
+          git push --force origin ${{ steps.validate.outputs.head_ref }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -67,7 +67,7 @@ The latest version of the AEM Forms Core Components, require the below minimum s
 
 | Forms Core Components | WCM Core Components | AEM Forms as a cloud service | Java  | Maven  |  
 |-----------------------|---------------------| ---------------------------- | ----- | ------ | 
-| 3.0.70                | 2.24.6             | Continual                    | 11 | 3.3.9+ |
+| 3.0.72                | 2.24.6             | Continual                    | 11 | 3.3.9+ |
 
 For a list of requirements for previous versions, see [Historical System Requirements](VERSIONS.md).
 

VERSIONS.md

@@ -4,6 +4,7 @@ See below for a full list of minimum system requirements for historical versions
 
 | Forms Core Components | WCM Core Components | AEM Forms as a cloud service | Java  | Maven  |  
 |-----------------------|---------------------| ---------------------------- | ----- | ------ |
+| 3.0.72                | 2.24.6             | Continual                    | 11 | 3.3.9+ |
 | 3.0.70                | 2.24.6             | Continual                    | 11 | 3.3.9+ |
 | 3.0.68                | 2.24.6             | Continual                    | 11 | 3.3.9+ |
 | 3.0.66                | 2.24.6             | Continual                    | 11 | 3.3.9+ |

all/pom.xml

@@ -21,7 +21,7 @@
     <parent>
         <groupId>com.adobe.aem</groupId>
         <artifactId>core-forms-components-parent</artifactId>
-        <version>3.0.71-SNAPSHOT</version>
+        <version>3.0.73-SNAPSHOT</version>
         <relativePath>../parent/pom.xml</relativePath>
     </parent>
 

bundles/af-core/pom.xml

@@ -20,7 +20,7 @@
     <parent>
         <groupId>com.adobe.aem</groupId>
         <artifactId>core-forms-components-parent</artifactId>
-        <version>3.0.71-SNAPSHOT</version>
+        <version>3.0.73-SNAPSHOT</version>
         <relativePath>../../parent/pom.xml</relativePath>
     </parent>
 

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.util.ComponentUtils;
@@ -59,6 +62,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/internal/models/v2/form/FormContainerImpl.java

@@ -27,16 +27,14 @@
 import org.apache.sling.models.annotations.Default;
 import org.apache.sling.models.annotations.Exporter;
 import org.apache.sling.models.annotations.Model;
-import org.apache.sling.models.annotations.injectorspecific.InjectionStrategy;
-import org.apache.sling.models.annotations.injectorspecific.Self;
-import org.apache.sling.models.annotations.injectorspecific.SlingObject;
-import org.apache.sling.models.annotations.injectorspecific.ValueMapValue;
+import org.apache.sling.models.annotations.injectorspecific.*;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import com.adobe.aemds.guide.common.GuideContainer;
+import com.adobe.aemds.guide.service.CoreComponentCustomPropertiesProvider;
 import com.adobe.aemds.guide.service.GuideSchemaType;
 import com.adobe.aemds.guide.utils.GuideConstants;
 import com.adobe.aemds.guide.utils.GuideUtils;
@@ -79,6 +77,11 @@ public class FormContainerImpl extends AbstractContainerImpl implements FormCont
     private static final String FD_IS_HAMBURGER_MENU_ENABLED = "fd:isHamburgerMenuEnabled";
     public static final String FD_FORM_DATA_ENABLED = "fd:formDataEnabled";
     public static final String FD_ROLE_ATTRIBUTE = "fd:roleAttribute";
+    private static final String FD_CUSTOM_FUNCTIONS_URL = "fd:customFunctionsUrl";
+    private static final String FD_DATA_URL = "fd:dataUrl";
+
+    @OSGiService(injectionStrategy = InjectionStrategy.OPTIONAL)
+    private CoreComponentCustomPropertiesProvider coreComponentCustomPropertiesProvider;
 
     @SlingObject(injectionStrategy = InjectionStrategy.OPTIONAL)
     @Nullable
@@ -318,7 +321,14 @@ public String getLanguageDirection() {
 
     @Override
     public @NotNull Map<String, Object> getProperties() {
-        Map<String, Object> properties = super.getProperties();
+        Map<String, Object> properties = new LinkedHashMap<>();
+        if (coreComponentCustomPropertiesProvider != null) {
+            Map<String, Object> customProperties = coreComponentCustomPropertiesProvider.getProperties();
+            if (customProperties != null) {
+                properties.putAll(customProperties);
+            }
+        }
+        properties.putAll(super.getProperties());
         if (getSchemaType() != null) {
             properties.put(FD_SCHEMA_TYPE, getSchemaType());
         }
@@ -335,6 +345,9 @@ public String getLanguageDirection() {
         properties.put(FD_ROLE_ATTRIBUTE, getRoleAttribute());
         properties.put(FD_FORM_DATA_ENABLED, formDataEnabled);
         properties.put(ReservedProperties.FD_AUTO_SAVE_PROPERTY_WRAPPER, this.autoSaveConfig);
+        properties.put(FD_CUSTOM_FUNCTIONS_URL, getCustomFunctionUrl());
+        properties.put(FD_DATA_URL, getDataUrl());
+
         return properties;
     }
 
@@ -388,4 +401,9 @@ public String getName() {
         return FormContainer.super.getName();
     }
 
+    @Override
+    public String getCustomFunctionUrl() {
+        return getContextPath() + ADOBE_GLOBAL_API_ROOT + FORMS_RUNTIME_API_GLOBAL_ROOT + "/customfunctions/" + getId();
+    }
+
 }

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

@@ -373,4 +373,16 @@ default void visit(Consumer<ComponentExporter> callback) throws Exception {}
     default String getParentPagePath() {
         return null;
     }
+
+    /**
+     * Returns the url from where the custom functions should be registered
+     * 
+     * @return custom function registration url
+     * @since com.adobe.cq.forms.core.components.models.form 5.9.5
+     */
+    @JsonIgnore
+    default String getCustomFunctionUrl() {
+        return null;
+    }
+
 }

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/main/java/com/adobe/cq/forms/core/components/models/form/package-info.java

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

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

@@ -23,6 +23,7 @@
 
 import com.adobe.aemds.guide.model.HCaptchaConfiguration;
 import com.adobe.aemds.guide.model.ReCaptchaConfigurationModel;
+import com.adobe.aemds.guide.model.TurnstileConfiguration;
 import com.adobe.aemds.guide.service.CloudConfigurationProvider;
 import com.adobe.aemds.guide.service.GuideException;
 import com.adobe.cq.forms.core.Utils;
@@ -54,10 +55,20 @@ public ReCaptchaConfigurationModel getRecaptchaCloudConfiguration(Resource resou
             return null;
         }
 
+        @Override
+        public String getCustomFunctionUrl(Resource resource) {
+            return null;
+        }
+
         @Override
         public HCaptchaConfiguration getHCaptchaCloudConfiguration(Resource resource) throws GuideException {
             return hCaptchaConfiguration;
         }
+
+        @Override
+        public TurnstileConfiguration getTurnstileCloudConfiguration(Resource resource) throws GuideException {
+            return null;
+        }
     };
 
     @BeforeEach