[INTERNAL] lib/processors/jsdoc: collect defaultClass information from runtime metadata

Cherry-picked from UI5/openui5@ead6e7fd6

Author: codeworrior

lib/processors/jsdoc/lib/ui5/plugin.js

@@ -1187,6 +1187,30 @@ function collectVisibilityInfo(settings, doclet, className, n) {
 	return visibility;
 }
 
+function convertDefaultClass(settings, doclet, n) {
+	const node = settings.defaultClass?.value;
+	if ( node == null ) {
+		// check if a @default tag is given (e.g. sap.ui.core.Element#customData)
+		// This is only taken into accout when there is no defaultClass property in the metadata
+		if ( doclet?.defaultvalue != null ) {
+			if ( typeof doclet.defaultvalue === "string" ) {
+				return doclet.defaultvalue;
+			}
+			error(`could not derive defaultClass for aggregation ${n} from default tag ${doclet.defaultvalue}`);
+		}
+		return undefined;
+	}
+	if ( node.type === Syntax.Identifier ) {
+		if ( currentModule.localNames[node.name]?.module ) {
+			return currentModule.localNames[node.name].module;
+		}
+		error(`could not derive defaultClass for aggregation ${n} from identifier ${node.name}`);
+		return "unknown";
+	}
+	error(`could not derive defaultClass for aggregation ${n} from node of type ${node.type}`);
+	return "unknown";
+}
+
 function collectClassInfo(extendCall, classDoclet) {
 
 	let baseType;
@@ -1349,6 +1373,7 @@ function collectClassInfo(extendCall, classDoclet) {
 				singularName : settings.singularName ? settings.singularName.value.value : guessSingularName(n),
 				cardinality : (settings.multiple && !settings.multiple.value.value) ? "0..1" : "0..n",
 				bindable : settings.bindable ? !!convertValue(settings.bindable.value) : false,
+				defaultClass: convertDefaultClass(settings, doclet, n),
 				methods: (methods = {
 					"get": "get" + N,
 					"destroy": "destroy" + N

lib/processors/jsdoc/lib/ui5/template/publish.js

@@ -1277,6 +1277,9 @@ function createAPIJSON4Symbol(symbol, omitDefaults) {
 				if ( aggr.altTypes ) {
 					curr.altTypes = aggr.altTypes.slice();
 				}
+				if ( aggr.defaultClass ) {
+					attrib("defaultClass", aggr.defaultClass);
+				}
 				attrib("cardinality", aggr.cardinality, '0..n');
 				attrib("visibility", aggr.visibility, 'public');
 				if (aggr.stakeholders) {
@@ -1934,9 +1937,8 @@ function createAPIJSON4Symbol(symbol, omitDefaults) {
 	return obj[0];
 }
 
-function postProcessAPIJSON(api) {
+function addExportInfo(symbols) {
 	const modules = {};
-	const symbols = api.symbols;
 
 	// collect modules and the symbols that refer to them
 	for ( let i = 0; i < symbols.length; i++) {
@@ -2058,6 +2060,13 @@ function postProcessAPIJSON(api) {
 	for ( const n in modules ) {
 		guessExports(n, modules[n]);
 	}
+}
+
+function postProcessAPIJSON(api) {
+
+	const symbols = api.symbols;
+
+	addExportInfo(symbols);
 
 	function findSymbol(name) {
 		if ( name == null || name === '' ) {
@@ -2086,6 +2095,28 @@ function postProcessAPIJSON(api) {
 		return (m && m[1]) || "";
 	}
 
+	// create a 2-level map of symbol names, first keyed by the exporting module and then by export name
+	const modules = Object.create(null);
+	for (const symbol of Object.values(externalSymbols)) {
+		if ( symbol.module && symbol.export !== undefined ) {
+			modules[symbol.module] ??= Object.create(null);
+			modules[symbol.module][symbol.export] = symbol.name;
+		}
+	}
+	for (const symbol of symbols) {
+		if ( symbol.module && symbol.export !== undefined ) {
+			modules[symbol.module] ??= Object.create(null);
+			modules[symbol.module][symbol.export] = symbol.name;
+		}
+	}
+
+	function findSymbolByModule(module, exportName) {
+		if (module === "unknown") {
+			return "unknown";
+		}
+		return modules[module]?.[exportName] ?? "unknown";
+	}
+
 	symbols.forEach((symbol) => {
 		// add note for enums which are not exposed by their name
 		if (symbol.kind === "enum" && symbol.export) {
@@ -2154,6 +2185,16 @@ function postProcessAPIJSON(api) {
 				}
 			}
 		}
+		/*
+		 * Up to here, the defaultClass only contains a module name. Replace it with the corresponding API (type) name.
+		 */
+		if (Array.isArray(symbol["ui5-metadata"].aggregations)) {
+			for (const aggr of symbol["ui5-metadata"].aggregations) {
+				if (aggr.defaultClass != null) {
+					aggr.defaultClass = findSymbolByModule(aggr.defaultClass, "");
+				}
+			}
+		}
 	});
 
 }