feat(af-core): contribute forms runtime schema enricher

bundles/af-core/pom.xml

@@ -472,6 +472,13 @@
             <classifier>apis</classifier>
         </dependency>
 
+        <dependency>
+            <groupId>com.adobe.aem</groupId>
+            <artifactId>sites-dataplane</artifactId>
+            <version>1.0.113-SNAPSHOT</version>
+            <scope>provided</scope>
+        </dependency>
+
         <!-- End of AEM and forms sdk versions -->
 
 

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/internal/dataplane/FormsComponentDefinitionEnricher.java

@@ -0,0 +1,263 @@
+package com.adobe.cq.forms.core.components.internal.dataplane;
+
+import com.adobe.aem.wcm.dataplane.openapimodels.pages.PageContentDefinitionComponentDefinitionsInner;
+import com.adobe.aem.wcm.dataplane.openapimodels.pages.PageContentDefinitionComponentDefinitionsInnerFieldsInner;
+import com.adobe.aem.wcm.dataplane.openapimodels.pages.PageContentDefinitionComponentDefinitionsInnerFieldsInnerOptionsInner;
+import com.adobe.aem.wcm.dataplane.schema.spi.ComponentDefinitionEnricher;
+import com.adobe.aem.wcm.dataplane.schema.spi.ComponentDefinitionEnrichmentContext;
+import com.adobe.aemds.guide.model.FormMetaData;
+import com.day.cq.wcm.foundation.forms.FormsManager;
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.api.resource.ResourceResolver;
+import org.apache.sling.api.resource.ValueMap;
+import org.osgi.service.component.annotations.Component;
+
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+@Component(service = ComponentDefinitionEnricher.class)
+public class FormsComponentDefinitionEnricher implements ComponentDefinitionEnricher {
+
+    private static final String GUIDE_CONTAINER_V1 = "core/fd/components/form/container/v1/container";
+    private static final String GUIDE_CONTAINER_V2 = "core/fd/components/form/container/v2/container";
+    private static final String GUIDE_CONTAINER_EDS = "fd/franklin/components/form/v1/form";
+    private static final String ACTION_TYPE_FIELD = "./actionType";
+    private static final String PREFILL_SERVICE_FIELD = "./prefillService";
+    private static final String DATASOURCE_NODE = "datasource";
+    private static final String GUIDE_DATA_MODEL = "guideDataModel";
+    private static final String NONE_OPTION_LABEL = "None";
+
+    @Override
+    public void enrich(ComponentDefinitionEnrichmentContext context) {
+        FormMetaData formMetaData = context.getResourceResolver().adaptTo(FormMetaData.class);
+        if (formMetaData == null) {
+            return;
+        }
+
+        Map<String, PageContentDefinitionComponentDefinitionsInner> componentDefinitions =
+            context.getComponentDefinitions();
+        componentDefinitions.entrySet().stream()
+            .filter(entry -> isGuideContainerComponent(entry.getValue()))
+            .map(Map.Entry::getKey)
+            .collect(Collectors.toList())
+            .forEach(componentType -> enrichContainer(componentType, componentDefinitions, context, formMetaData));
+    }
+
+    private void enrichContainer(
+        String componentType,
+        Map<String, PageContentDefinitionComponentDefinitionsInner> componentDefinitions,
+        ComponentDefinitionEnrichmentContext context,
+        FormMetaData formMetaData) {
+        PageContentDefinitionComponentDefinitionsInner containerDefinition = componentDefinitions.get(componentType);
+        if (containerDefinition == null || containerDefinition.getFields() == null) {
+            return;
+        }
+
+        setDynamicOptions(
+            containerDefinition,
+            ACTION_TYPE_FIELD,
+            collectSubmitActionOptions(formMetaData, componentType, context, componentDefinitions)
+        );
+        setDynamicOptions(
+            containerDefinition,
+            PREFILL_SERVICE_FIELD,
+            collectPrefillServiceOptions(formMetaData, context, componentDefinitions)
+        );
+    }
+
+    private List<PageContentDefinitionComponentDefinitionsInnerFieldsInnerOptionsInner> collectSubmitActionOptions(
+        FormMetaData formMetaData,
+        String componentType,
+        ComponentDefinitionEnrichmentContext context,
+        Map<String, PageContentDefinitionComponentDefinitionsInner> componentDefinitions) {
+        String guideDataModel = resolveDatasourceProperty(componentType, ACTION_TYPE_FIELD, GUIDE_DATA_MODEL,
+            context.getResourceResolver());
+        Set<String> uniqueResourceTypes = new HashSet<>();
+        List<PageContentDefinitionComponentDefinitionsInnerFieldsInnerOptionsInner> options = new ArrayList<>();
+        Iterator<FormsManager.ComponentDescription> iterator = formMetaData.getSubmitActions();
+
+        while (iterator != null && iterator.hasNext()) {
+            FormsManager.ComponentDescription description = iterator.next();
+            if (description == null || !uniqueResourceTypes.add(description.getResourceType())) {
+                continue;
+            }
+
+            Resource actionResource = findComponentResource(description.getResourceType(), context.getResourceResolver());
+            if (!matchesGuideDataModel(actionResource, guideDataModel)) {
+                continue;
+            }
+
+            options.add(option(resolveOptionLabel(description), description.getResourceType()));
+            addRuntimeDefinition(description.getResourceType(), componentDefinitions, context);
+        }
+        return options;
+    }
+
+    private List<PageContentDefinitionComponentDefinitionsInnerFieldsInnerOptionsInner> collectPrefillServiceOptions(
+        FormMetaData formMetaData,
+        ComponentDefinitionEnrichmentContext context,
+        Map<String, PageContentDefinitionComponentDefinitionsInner> componentDefinitions) {
+        List<PageContentDefinitionComponentDefinitionsInnerFieldsInnerOptionsInner> options = new ArrayList<>();
+        options.add(option(NONE_OPTION_LABEL, ""));
+
+        Iterator<FormsManager.ComponentDescription> iterator = formMetaData.getPrefillActions();
+        while (iterator != null && iterator.hasNext()) {
+            FormsManager.ComponentDescription description = iterator.next();
+            if (description == null) {
+                continue;
+            }
+
+            options.add(option(resolveOptionLabel(description), description.getResourceType()));
+            addRuntimeDefinition(description.getResourceType(), componentDefinitions, context);
+        }
+        return options;
+    }
+
+    private void addRuntimeDefinition(
+        String componentType,
+        Map<String, PageContentDefinitionComponentDefinitionsInner> componentDefinitions,
+        ComponentDefinitionEnrichmentContext context) {
+        if (componentType == null || componentType.isEmpty() || componentDefinitions.containsKey(componentType)) {
+            return;
+        }
+
+        PageContentDefinitionComponentDefinitionsInner schema = context.resolveComponentDialog(componentType);
+        if (schema != null) {
+            componentDefinitions.put(componentType, schema);
+        }
+    }
+
+    private void setDynamicOptions(
+        PageContentDefinitionComponentDefinitionsInner schema,
+        String fieldName,
+        List<PageContentDefinitionComponentDefinitionsInnerFieldsInnerOptionsInner> options) {
+        if (schema.getFields() == null || options == null || options.isEmpty()) {
+            return;
+        }
+
+        schema.getFields().stream()
+            .filter(field -> fieldName.equals(field.getName()))
+            .findFirst()
+            .ifPresent(field -> field.setOptions(options));
+    }
+
+    private boolean isGuideContainerComponent(PageContentDefinitionComponentDefinitionsInner definition) {
+        if (definition == null) {
+            return false;
+        }
+        return isGuideContainerType(definition.getComponentType()) || isGuideContainerType(definition.getComponentSuperType());
+    }
+
+    private boolean isGuideContainerType(String componentType) {
+        if (componentType == null || componentType.isEmpty()) {
+            return false;
+        }
+        String normalizedComponentType = normalizeComponentType(componentType);
+        // TODO: Support EDS form container enrichment for fd/franklin/components/form/v1/form
+        // once AEM_EDGE content definition exposes compatible runtime-backed form properties.
+        return GUIDE_CONTAINER_V1.equals(normalizedComponentType) || GUIDE_CONTAINER_V2.equals(normalizedComponentType);
+    }
+
+    private boolean matchesGuideDataModel(Resource actionResource, String guideDataModel) {
+        if (guideDataModel == null || guideDataModel.isEmpty()) {
+            return true;
+        }
+        if (actionResource == null) {
+            return false;
+        }
+        String supportedModels = actionResource.getValueMap().get(GUIDE_DATA_MODEL, "");
+        return supportedModels.toLowerCase().contains(guideDataModel.toLowerCase());
+    }
+
+    private String resolveDatasourceProperty(
+        String componentType,
+        String fieldName,
+        String propertyName,
+        ResourceResolver resourceResolver) {
+        Resource componentResource = resolveComponentResource(componentType, resourceResolver);
+        if (componentResource == null) {
+            return "";
+        }
+
+        Resource dialogResource = componentResource.getChild("_cq_dialog");
+        if (dialogResource == null) {
+            return "";
+        }
+
+        Resource fieldResource = findFieldResource(dialogResource, fieldName);
+        if (fieldResource == null) {
+            return "";
+        }
+
+        Resource datasource = fieldResource.getChild(DATASOURCE_NODE);
+        if (datasource == null) {
+            return "";
+        }
+
+        return datasource.getValueMap().get(propertyName, "");
+    }
+
+    private Resource resolveComponentResource(String componentType, ResourceResolver resourceResolver) {
+        if (componentType == null || componentType.isEmpty()) {
+            return null;
+        }
+
+        String normalizedComponentType = normalizeComponentType(componentType);
+        Resource mergedComponentResource = resourceResolver.getResource("/mnt/override/" + normalizedComponentType);
+        if (mergedComponentResource != null) {
+            return mergedComponentResource;
+        }
+
+        return findComponentResource(componentType, resourceResolver);
+    }
+
+    private Resource findComponentResource(String componentType, ResourceResolver resourceResolver) {
+        if (componentType == null || componentType.isEmpty()) {
+            return null;
+        }
+        if (componentType.startsWith("/apps/") || componentType.startsWith("/libs/")) {
+            return resourceResolver.getResource(componentType);
+        }
+
+        Resource appResource = resourceResolver.getResource("/apps/" + componentType);
+        if (appResource != null) {
+            return appResource;
+        }
+        return resourceResolver.getResource("/libs/" + componentType);
+    }
+
+    private Resource findFieldResource(Resource resource, String fieldName) {
+        ValueMap properties = resource.getValueMap();
+        if (fieldName.equals(properties.get("name", ""))) {
+            return resource;
+        }
+
+        for (Resource child : resource.getChildren()) {
+            Resource match = findFieldResource(child, fieldName);
+            if (match != null) {
+                return match;
+            }
+        }
+        return null;
+    }
+
+    private String normalizeComponentType(String componentType) {
+        return componentType.startsWith("/") ? componentType.substring(1) : componentType;
+    }
+
+    private String resolveOptionLabel(FormsManager.ComponentDescription description) {
+        String title = description.getTitle();
+        return title == null || title.isEmpty() ? description.getResourceType() : title;
+    }
+
+    private PageContentDefinitionComponentDefinitionsInnerFieldsInnerOptionsInner option(String name, String value) {
+        return new PageContentDefinitionComponentDefinitionsInnerFieldsInnerOptionsInner()
+            .name(name)
+            .value(value);
+    }
+}