feat: add property imageRecommendation refactor to programmatically get brandingConfig and update README

Author: soul2zimate

src/main/java/io/github/guacsec/trustifyda/integration/report/BrandingConfig.java

@@ -28,4 +28,6 @@ public interface BrandingConfig {
   String exploreTitle();
 
   String exploreDescription();
+
+  String imageRecommendation();
 }

src/main/java/io/github/guacsec/trustifyda/integration/report/ReportTemplate.java

@@ -26,6 +26,8 @@
 import org.apache.camel.Body;
 import org.apache.camel.Exchange;
 import org.apache.camel.ExchangeProperty;
+import org.eclipse.microprofile.config.Config;
+import org.eclipse.microprofile.config.ConfigProvider;
 import org.eclipse.microprofile.config.inject.ConfigProperty;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
@@ -58,9 +60,6 @@ public class ReportTemplate {
   @ConfigProperty(name = "telemetry.disabled", defaultValue = "false")
   Boolean disabled;
 
-  // Branding configuration
-  @Inject Optional<BrandingConfig> brandingConfig;
-
   @Inject ObjectMapper mapper;
 
   public Map<String, Object> setVariables(
@@ -77,8 +76,8 @@ public Map<String, Object> setVariables(
     params.put("cveIssueTemplate", cveIssuePathRegex);
     params.put("imageMapping", getImageMapping());
     params.put("rhdaSource", rhdaSource);
-    // Only include branding config if it's present
-    brandingConfig.ifPresent(config -> params.put("brandingConfig", getBrandingConfigMap(config)));
+    getBrandingConfig()
+        .ifPresent(config -> params.put("brandingConfig", getBrandingConfigMap(config)));
     if (!disabled && writeKey.isPresent()) {
       params.put("userId", userId);
       params.put("anonymousId", anonymousId);
@@ -113,15 +112,86 @@ private String getImageMapping() throws JsonProcessingException {
     return objectWriter.writeValueAsString(urlMapping);
   }
 
+  private Optional<BrandingConfig> getBrandingConfig() {
+    try {
+      Config config = ConfigProvider.getConfig();
+      return config
+          .getOptionalValue("branding.display-name", String.class)
+          .filter(displayName -> !displayName.isEmpty())
+          .map(
+              displayName ->
+                  new BrandingConfigImpl(
+                      displayName,
+                      config.getOptionalValue("branding.explore-url", String.class).orElse(""),
+                      config.getOptionalValue("branding.explore-title", String.class).orElse(""),
+                      config
+                          .getOptionalValue("branding.explore-description", String.class)
+                          .orElse(""),
+                      config
+                          .getOptionalValue("branding.image-recommendation", String.class)
+                          .orElse("")));
+    } catch (Exception e) {
+      return Optional.empty();
+    }
+  }
+
   private Map<String, String> getBrandingConfigMap(BrandingConfig config) {
     Map<String, String> branding = new HashMap<>();
     branding.put("displayName", config.displayName());
     branding.put("exploreUrl", config.exploreUrl());
     branding.put("exploreTitle", config.exploreTitle());
     branding.put("exploreDescription", config.exploreDescription());
+    branding.put("imageRecommendation", config.imageRecommendation());
     return branding;
   }
 
+  @RegisterForReflection
+  private static class BrandingConfigImpl implements BrandingConfig {
+    private final String displayName;
+    private final String exploreUrl;
+    private final String exploreTitle;
+    private final String exploreDescription;
+    private final String imageRecommendation;
+
+    public BrandingConfigImpl(
+        String displayName,
+        String exploreUrl,
+        String exploreTitle,
+        String exploreDescription,
+        String imageRecommendation) {
+      this.displayName = displayName;
+      this.exploreUrl = exploreUrl;
+      this.exploreTitle = exploreTitle;
+      this.exploreDescription = exploreDescription;
+      this.imageRecommendation = imageRecommendation;
+    }
+
+    @Override
+    public String displayName() {
+      return displayName;
+    }
+
+    @Override
+    public String exploreUrl() {
+      return exploreUrl;
+    }
+
+    @Override
+    public String exploreTitle() {
+      return exploreTitle;
+    }
+
+    @Override
+    public String exploreDescription() {
+      return exploreDescription;
+    }
+
+    @Override
+    public String imageRecommendation() {
+      return imageRecommendation;
+    }
+  }
+
   @RegisterForReflection
   public static record IssueLinkFormatter(String issuePathRegex) {
 

src/main/resources/freemarker/templates/generated/main.js

@@ -2,137 +2,6 @@
 
 This project supports flexible branding through backend environment variables. The system uses **default** branding and allows you to override specific elements as needed.
 
-## Quick Start
-
-### Using Predefined Profiles
-
-**Default branding:**
-```bash
-# Default profile - no additional flags needed
-./mvnw quarkus:dev
-```
-
-**Custom organization branding:**
-```bash
-# Example using a custom profile (e.g., myorg)
-./mvnw quarkus:dev -Dquarkus.profile=myorg
-```
-
-### Using Environment Variables (Alternative)
-```bash
-# Start development server (branding controlled by backend environment variables)
-npm start
-```
-
-### Production Build
-```bash
-# Build for production (branding controlled by backend environment variables)
-npm run build
-```
-
-## How It Works
-
-1. **Backend Configuration**: Java backend reads `BRANDING_XXX` environment variables
-2. **Runtime Injection**: Branding configuration is passed to the React app through `appData`
-3. **Component Usage**: React components read branding configuration from the app context
-4. **Default-First**: All defaults are set to standard values, specific brands override as needed
-
-## Available Environment Variables
-
-Configure branding by setting these environment variables for the Java backend:
-
-```bash
-# Brand identity
-BRANDING_DISPLAY_NAME=Your Brand Name           # Used for conditional logic and remediation title
-
-# Explore section
-BRANDING_EXPLORE_URL=https://your-url.com       # URL for "Take me there" button
-BRANDING_EXPLORE_TITLE=Your Explore Title             # Title for explore section
-BRANDING_EXPLORE_DESCRIPTION=Your description text    # Description text
-```
-
-## Branding Logic
-
-The system uses `displayName` for all branding decisions:
-
-- **Custom organization branding**: Uses the provided `displayName` (e.g., "MyOrg" shows "MyOrg Remediations")
-- **Default branding**: Used when no custom branding is configured
-
-## Icon System
-
-The system uses a CSS-based icon override approach:
-
-- **Default icon**: Built-in Trustify logo (PNG)
-- **Custom icons**: Organizations can override the default icon using CSS in their private projects
-
-## Examples
-
-### Method 1: Using Predefined Profile
-
-**Default branding:**
-```bash
-# Default behavior (no profile needed)
-./mvnw quarkus:dev
-```
-
-**Custom organization branding:**
-```bash
-# Example using a custom profile
-./mvnw quarkus:dev -Dquarkus.profile=myorg
-```
-
-**Production builds with profiles:**
-```bash
-# Default production build
-./mvnw clean package
-
-# Custom organization production build
-./mvnw clean package -Dquarkus.profile=myorg
-```
-
-### Method 2: Using Environment Variables
-
-**Default Configuration (no environment variables needed):**
-```bash
-# No environment variables needed - uses default Trustify branding
-./mvnw quarkus:dev
-```
-
-**Custom Organization Configuration:**
-```bash
-export BRANDING_DISPLAY_NAME="MyOrg"
-export BRANDING_EXPLORE_URL="https://example.com/security-tools"
-export BRANDING_EXPLORE_TITLE="Learn about MyOrg Security"
-export BRANDING_EXPLORE_DESCRIPTION="Explore our comprehensive security analysis tools and vulnerability management platform."
-
-./mvnw quarkus:dev
-```
-
-## Backend Integration
-
-The branding configuration is handled using Quarkus `@ConfigMapping`:
-
-**BrandingConfig.java:**
-```java
-@ConfigMapping(prefix = "branding")
-public interface BrandingConfig {
-  String displayName();
-  String exploreUrl();
-  String exploreTitle();
-  String exploreDescription();
-}
-```
-
-**ReportTemplate.java:**
-```java
-@Inject Optional<BrandingConfig> brandingConfig;
-
-// Only include branding config if it's present
-brandingConfig.ifPresent(config -> params.put("brandingConfig", getBrandingConfigMap(config)));
-```
-
-The configuration is then passed to the frontend via the `appData` object in the Freemarker template.
-
 ## Profile Configuration
 
 The branding profiles are defined in `src/main/resources/application.properties`:
@@ -143,15 +12,19 @@ branding.display.name=Trustify
 branding.explore.url=https://guac.sh/trustify/
 branding.explore.title=Learn more about Trustify
 branding.explore.description=The Trustify project is a collection of software components that enables you to store and retrieve Software Bill of Materials (SBOMs), and advisory documents.
+branding.image.recommendation=
 
 # Example: Custom organization branding profile
 %myorg.branding.display.name=MyOrg
 %myorg.branding.explore.url=https://example.com/security-tools
 %myorg.branding.explore.title=Learn about MyOrg Security
 %myorg.branding.explore.description=Explore our comprehensive security analysis tools and vulnerability management platform.
+%myorg.branding.image.recommendation=Custom container image recommendations for enhanced security.
 ```
 
-## Creating Custom Branding Profiles
+## Examples
+
+### Method 1: Using Predefined Profile
 
 To create a new branding profile for your organization:
 
@@ -162,6 +35,7 @@ To create a new branding profile for your organization:
    %myorg.branding.explore.url=https://your-org.com/security
    %myorg.branding.explore.title=Learn about Your Org Security
    %myorg.branding.explore.description=Your custom description here.
+   %myorg.branding.image.recommendation=Your custom container image recommendation text.
    ```
 
 2. **Use the profile** when running the application:
@@ -171,6 +45,19 @@ To create a new branding profile for your organization:
 
 3. **Override icons in private projects** using CSS to provide custom organization icons
 
+### Method 2: Using Environment Variables
+
+**Custom Organization Configuration:**
+```bash
+export BRANDING_DISPLAY_NAME="MyOrg"
+export BRANDING_EXPLORE_URL="https://example.com/security-tools"
+export BRANDING_EXPLORE_TITLE="Learn about MyOrg Security"
+export BRANDING_EXPLORE_DESCRIPTION="Explore our comprehensive security analysis tools and vulnerability management platform."
+export BRANDING_IMAGE_RECOMMENDATION="Custom container image recommendations for enhanced security."
+
+./mvnw quarkus:dev
+```
+
 Environment variables will override profile settings if both are provided.
 
 ## Custom Icon Implementation
@@ -202,6 +89,7 @@ Add to `/src/main/resources/application.properties`:
 %myorg.branding.explore.url=https://myorg.com/security
 %myorg.branding.explore.title=Learn about MyOrg Security
 %myorg.branding.explore.description=Explore our comprehensive security analysis tools and vulnerability management platform.
+%myorg.branding.image.recommendation=Custom container image recommendations for enhanced security.
 ```
 
 **Step 4: Build with your changes**

ui/BRANDING.md

@@ -18,6 +18,7 @@ export interface BrandingConfig {
   exploreUrl: string;
   exploreTitle: string;
   exploreDescription: string;
+  imageRecommendation: string;
 }
 
 export interface ReportMap {