scalar upgrade to version 0.4.3

Author: bnasslahsen

pom.xml

@@ -63,7 +63,7 @@
 		<spring-cloud-function.version>4.2.2</spring-cloud-function.version>
 		<spring-security-oauth2-authorization-server.version>1.4.3
 		</spring-security-oauth2-authorization-server.version>
-		<scalar.version>0.3.12</scalar.version>
+		<scalar.version>0.4.3</scalar.version>
 		<skipPublishing>false</skipPublishing>
 		<commons-lang3.version>3.18.0</commons-lang3.version>
 	</properties>

springdoc-openapi-starter-common/src/main/java/org/springdoc/scalar/AbstractScalarController.java

@@ -21,7 +21,7 @@
  *  *  *  *
  *  *  *
  *  *
- *  
+ *
  */
 
 package org.springdoc.scalar;
@@ -30,15 +30,17 @@
 import java.io.InputStream;
 import java.net.URLDecoder;
 import java.nio.charset.StandardCharsets;
-import java.util.List;
-import java.util.stream.Collectors;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.scalar.maven.webjar.ScalarProperties;
-import com.scalar.maven.webjar.ScalarProperties.ScalarSource;
+import com.scalar.maven.webjar.internal.ScalarConfiguration;
+import com.scalar.maven.webjar.internal.ScalarConfigurationMapper;
 
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 
+import static org.springdoc.scalar.ScalarConstants.HTML_TEMPLATE_PATH;
 import static org.springdoc.scalar.ScalarConstants.SCALAR_DEFAULT_URL;
 import static org.springdoc.scalar.ScalarConstants.SCALAR_JS_FILENAME;
 import static org.springframework.util.AntPathMatcher.DEFAULT_PATH_SEPARATOR;
@@ -60,14 +62,21 @@ public abstract class AbstractScalarController {
 	 */
 	protected final String originalScalarUrl;
 
+	/**
+	 * The Object mapper.
+	 */
+	private final ObjectMapper objectMapper;
+
 	/**
 	 * Instantiates a new Abstract scalar controller.
 	 *
 	 * @param scalarProperties the scalar properties
+	 * @param objectMapper     the object mapper
 	 */
-	protected AbstractScalarController(ScalarProperties scalarProperties) {
+	protected AbstractScalarController(ScalarProperties scalarProperties, ObjectMapper objectMapper) {
 		this.scalarProperties = scalarProperties;
 		this.originalScalarUrl = scalarProperties.getUrl();
+		this.objectMapper = objectMapper;
 	}
 
 	/**
@@ -82,22 +91,18 @@ protected AbstractScalarController(ScalarProperties scalarProperties) {
 	 */
 	protected ResponseEntity<String> getDocs(String requestUrl) throws IOException {
 		// Load the template HTML
-		InputStream inputStream = getClass().getResourceAsStream("/META-INF/resources/webjars/scalar/index.html");
+		InputStream inputStream = getClass().getResourceAsStream(HTML_TEMPLATE_PATH);
 		if (inputStream == null) {
-			return ResponseEntity.notFound().build();
+			throw new IOException("HTML template not found at: " + HTML_TEMPLATE_PATH);
 		}
 
 		String html = new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
-		requestUrl = decode(requestUrl);
+
 		// Replace the placeholders with actual values
-		String cdnUrl = buildJsBundleUrl(requestUrl);
+		String bundleUrl = buildJsBundleUrl(requestUrl);
 		String injectedHtml = html
-				.replace("__JS_BUNDLE_URL__", cdnUrl)
-				.replace("__CONFIGURATION__", """
-						    {
-						      url: "%s"
-						    }
-						""".formatted(buildApiDocsUrl(requestUrl)));
+				.replace("__JS_BUNDLE_URL__", bundleUrl)
+				.replace("__CONFIGURATION__", buildConfigurationJson(buildApiDocsUrl(requestUrl)));
 
 		return ResponseEntity.ok()
 				.contentType(MediaType.TEXT_HTML)
@@ -163,7 +168,7 @@ protected String buildJsBundleUrl(String requestUrl, String scalarPath) {
 		if (SCALAR_DEFAULT_URL.equals(originalScalarUrl)) {
 			int firstPathSlash = requestUrl.indexOf('/', requestUrl.indexOf("://") + 3);
 			String path = firstPathSlash >= 0 ? requestUrl.substring(firstPathSlash) : "/";
-			if( path.endsWith("/"))
+			if (path.endsWith("/"))
 				path = path.substring(0, path.length() - 1);
 			return path + DEFAULT_PATH_SEPARATOR + SCALAR_JS_FILENAME;
 		}
@@ -187,158 +192,20 @@ protected String buildJsBundleUrl(String requestUrl, String scalarPath) {
 	protected abstract String buildJsBundleUrl(String requestUrl);
 
 	/**
-	 * Builds the configuration JSON for the Scalar API Reference.
+	 * Build configuration json string.
 	 *
-	 * @return the configuration JSON as a string
+	 * @param requestUrl the request url
+	 * @return the string
 	 */
-	private String buildConfigurationJson() {
-		StringBuilder config = new StringBuilder();
-		config.append("{");
-
-		// Add URL
-		config.append("\n  url: \"").append(escapeJson(scalarProperties.getUrl())).append("\"");
-
-		// Add sources
-		if (scalarProperties.getSources() != null && !scalarProperties.getSources().isEmpty()) {
-			config.append(",\n  sources: ").append(buildSourcesJsonArray(scalarProperties.getSources()));
-		}
-
-		// Add showSidebar
-		if (!scalarProperties.isShowSidebar()) {
-			config.append(",\n  showSidebar: false");
-		}
-
-		// Add hideModels
-		if (scalarProperties.isHideModels()) {
-			config.append(",\n  hideModels: true");
-		}
-
-		// Add hideTestRequestButton
-		if (scalarProperties.isHideTestRequestButton()) {
-			config.append(",\n  hideTestRequestButton: true");
-		}
-
-		// Add darkMode
-		if (scalarProperties.isDarkMode()) {
-			config.append(",\n  darkMode: true");
-		}
-
-		// Add hideDarkModeToggle
-		if (scalarProperties.isHideDarkModeToggle()) {
-			config.append(",\n  hideDarkModeToggle: true");
-		}
-
-		// Add customCss
-		if (scalarProperties.getCustomCss() != null && !scalarProperties.getCustomCss().trim().isEmpty()) {
-			config.append(",\n  customCss: \"").append(escapeJson(scalarProperties.getCustomCss())).append("\"");
+	private String buildConfigurationJson(String requestUrl) {
+		try {
+			this.scalarProperties.setUrl(requestUrl);
+			ScalarConfiguration config = ScalarConfigurationMapper.map(scalarProperties);
+			return objectMapper.writeValueAsString(config);
 		}
-
-		// Add theme
-		if (scalarProperties.getTheme() != null && !"default".equals(scalarProperties.getTheme())) {
-			config.append(",\n  theme: \"").append(escapeJson(scalarProperties.getTheme())).append("\"");
+		catch (JsonProcessingException e) {
+			throw new RuntimeException("Failed to serialize Scalar configuration", e);
 		}
-
-		// Add layout
-		if (scalarProperties.getLayout() != null && !"modern".equals(scalarProperties.getLayout())) {
-			config.append(",\n  layout: \"").append(escapeJson(scalarProperties.getLayout())).append("\"");
-		}
-
-		// Add hideSearch
-		if (scalarProperties.isHideSearch()) {
-			config.append(",\n  hideSearch: true");
-		}
-
-		// Add documentDownloadType
-		if (scalarProperties.getDocumentDownloadType() != null && !"both".equals(scalarProperties.getDocumentDownloadType())) {
-			config.append(",\n  documentDownloadType: \"").append(escapeJson(scalarProperties.getDocumentDownloadType())).append("\"");
-		}
-
-		config.append("\n}");
-		return config.toString();
 	}
 
-	/**
-	 * Escapes a string for JSON output.
-	 *
-	 * @param input the input string
-	 * @return the escaped string
-	 */
-	private String escapeJson(String input) {
-		if (input == null) {
-			return "";
-		}
-		return input.replace("\\", "\\\\")
-				.replace("\"", "\\\"")
-				.replace("\n", "\\n")
-				.replace("\r", "\\r")
-				.replace("\t", "\\t");
-	}
-
-	    /**
-     * Builds the JSON for the OpenAPI reference sources
-     *
-     * @param sources list of OpenAPI reference sources
-     * @return the sources as a JSON string
-     */
-    private String buildSourcesJsonArray(List<ScalarSource> sources) {
-        final StringBuilder builder = new StringBuilder("[");
-
-        // Filter out sources with invalid urls
-        final List<ScalarProperties.ScalarSource> filteredSources = sources.stream()
-                .filter(source -> isNotNullOrBlank(source.getUrl()))
-                .collect(Collectors.toList());
-
-        // Append each source to json array
-        for (int i = 0; i < filteredSources.size(); i++) {
-            final ScalarProperties.ScalarSource source = filteredSources.get(i);
-
-            final String sourceJson = buildSourceJson(source);
-            builder.append("\n").append(sourceJson);
-
-            if (i != filteredSources.size() - 1) {
-                builder.append(",");
-            }
-        }
-
-        builder.append("\n]");
-        return builder.toString();
-    }
-
-	/**
-	 * Builds the JSON for an OpenAPI reference source
-	 *
-	 * @param source the OpenAPI reference source
-	 * @return the source as a JSON string
-	 */
-	private String buildSourceJson(ScalarProperties.ScalarSource source) {
-		final StringBuilder builder = new StringBuilder("{");
-
-		builder.append("\n  url: \"").append(escapeJson(source.getUrl())).append("\"");
-
-
-		if (isNotNullOrBlank(source.getTitle())) {
-			builder.append(",\n  title: \"").append(escapeJson(source.getTitle())).append("\"");
-		}
-
-		if (isNotNullOrBlank(source.getSlug())) {
-			builder.append(",\n  slug: \"").append(escapeJson(source.getSlug())).append("\"");
-		}
-
-		if (source.isDefault() != null) {
-			builder.append(",\n  default: ").append(source.isDefault());
-		}
-
-		builder.append("\n}");
-		return builder.toString();
-	}
-	
-	/**
-	 * Returns whether a String is not null or blank
-	 *
-	 * @param input the string
-	 * @return whether the string is not null or blank
-	 */
-	private boolean isNotNullOrBlank(String input) {
-		return input != null && !input.isBlank();
-	}
 }

springdoc-openapi-starter-common/src/main/java/org/springdoc/scalar/ScalarConstants.java

@@ -46,10 +46,15 @@ public class ScalarConstants {
 	/**
 	 * The constant SCALAR_DEFAULT_URL.
 	 */
-	public static final String SCALAR_DEFAULT_URL = "https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json";
+	public static final String SCALAR_DEFAULT_URL = "https://registry.scalar.com/@scalar/apis/galaxy?format=json";
 
 	/**
 	 * The constant DEFAULT_SCALAR_ACTUATOR_PATH.
 	 */
 	public static final String DEFAULT_SCALAR_ACTUATOR_PATH = "scalar";
+
+	/**
+	 * The constant HTML_TEMPLATE_PATH.
+	 */
+	public static final String HTML_TEMPLATE_PATH = "/META-INF/resources/webjars/scalar/index.html";
 }

springdoc-openapi-starter-webflux-scalar/src/main/java/org/springdoc/webflux/scalar/ScalarActuatorController.java

@@ -28,6 +28,7 @@
 
 import java.io.IOException;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.scalar.maven.webjar.ScalarProperties;
 import io.swagger.v3.oas.annotations.Operation;
 import org.springdoc.scalar.AbstractScalarController;
@@ -59,9 +60,10 @@ public class ScalarActuatorController extends AbstractScalarController {
 	 *
 	 * @param scalarProperties      the scalar properties
 	 * @param webEndpointProperties the web endpoint properties
+	 * @param objectMapper          the object mapper
 	 */
-	protected ScalarActuatorController(ScalarProperties scalarProperties, WebEndpointProperties webEndpointProperties) {
-		super(scalarProperties);
+	protected ScalarActuatorController(ScalarProperties scalarProperties, WebEndpointProperties webEndpointProperties, ObjectMapper objectMapper) {
+		super(scalarProperties, objectMapper);
 		this.webEndpointProperties = webEndpointProperties;
 	}
 

springdoc-openapi-starter-webflux-scalar/src/main/java/org/springdoc/webflux/scalar/ScalarConfiguration.java

@@ -26,6 +26,7 @@
 
 package org.springdoc.webflux.scalar;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.scalar.maven.webjar.ScalarProperties;
 import org.springdoc.core.configuration.SpringDocConfiguration;
 import org.springdoc.core.events.SpringDocAppInitializer;
@@ -69,14 +70,15 @@ public class ScalarConfiguration {
 	 *
 	 * @param scalarProperties          the scalar properties
 	 * @param springDocConfigProperties the spring doc config properties
+	 * @param objectMapper              the object mapper
 	 * @return the scalar web mvc controller
 	 */
 	@Bean
 	@ConditionalOnProperty(name = SPRINGDOC_USE_MANAGEMENT_PORT, havingValue = "false", matchIfMissing = true)
 	@ConditionalOnMissingBean
 	@Lazy(false)
-	ScalarWebFluxController scalarWebMvcController(ScalarProperties scalarProperties, SpringDocConfigProperties springDocConfigProperties) {
-		return new ScalarWebFluxController(scalarProperties, springDocConfigProperties);
+	ScalarWebFluxController scalarWebMvcController(ScalarProperties scalarProperties, SpringDocConfigProperties springDocConfigProperties, ObjectMapper objectMapper) {
+		return new ScalarWebFluxController(scalarProperties, springDocConfigProperties, objectMapper);
 	}
 
 	/**
@@ -118,13 +120,14 @@ static class SwaggerActuatorWelcomeConfiguration {
 		 *
 		 * @param properties            the properties
 		 * @param webEndpointProperties the web endpoint properties
+		 * @param objectMapper          the object mapper
 		 * @return the scalar actuator controller
 		 */
 		@Bean
 		@ConditionalOnMissingBean
 		@Lazy(false)
-		ScalarActuatorController scalarActuatorController(ScalarProperties properties, WebEndpointProperties webEndpointProperties) {
-			return new ScalarActuatorController(properties, webEndpointProperties);
+		ScalarActuatorController scalarActuatorController(ScalarProperties properties, WebEndpointProperties webEndpointProperties, ObjectMapper objectMapper) {
+			return new ScalarActuatorController(properties, webEndpointProperties, objectMapper);
 		}
 
 		/**

springdoc-openapi-starter-webflux-scalar/src/main/java/org/springdoc/webflux/scalar/ScalarWebFluxController.java

@@ -28,6 +28,7 @@
 
 import java.io.IOException;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.scalar.maven.webjar.ScalarProperties;
 import org.springdoc.core.properties.SpringDocConfigProperties;
 import org.springdoc.scalar.AbstractScalarController;
@@ -61,12 +62,20 @@ public class ScalarWebFluxController extends AbstractScalarController {
 	 *
 	 * @param scalarProperties          the scalar properties
 	 * @param springDocConfigProperties the spring doc config properties
+	 * @param objectMapper              the object mapper
 	 */
-	protected ScalarWebFluxController(ScalarProperties scalarProperties, SpringDocConfigProperties springDocConfigProperties) {
-		super(scalarProperties);
+	protected ScalarWebFluxController(ScalarProperties scalarProperties, SpringDocConfigProperties springDocConfigProperties, ObjectMapper objectMapper) {
+		super(scalarProperties, objectMapper);
 		this.springDocConfigProperties = springDocConfigProperties;
 	}
 
+	/**
+	 * Gets docs.
+	 *
+	 * @param serverHttpRequest the server http request
+	 * @return the docs
+	 * @throws IOException the io exception
+	 */
 	@GetMapping
 	public ResponseEntity<String> getDocs(ServerHttpRequest serverHttpRequest) throws IOException {
 		return super.getDocs(serverHttpRequest.getURI().toString());