@ui5/builder 4.0.3 → 4.0.5

package/CHANGELOG.md

@@ -2,7 +2,16 @@
 All notable changes to this project will be documented in this file.  
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-A list of unreleased changes can be found [here](https://github.com/SAP/ui5-builder/compare/v4.0.3...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-builder/compare/v4.0.5...HEAD).
+
+<a name="v4.0.5"></a>
+## [v4.0.5] - 2024-12-10
+
+<a name="v4.0.4"></a>
+## [v4.0.4] - 2024-11-29
+### Dependency Updates
+- Switch from "rimraf" to native "fs.rm" ([#1098](https://github.com/SAP/ui5-builder/issues/1098)) [`0adf4da`](https://github.com/SAP/ui5-builder/commit/0adf4da0e747f1fb46cf0bf0da7b3e0af8e9bcec)
+
 
 <a name="v4.0.3"></a>
 ## [v4.0.3] - 2024-08-27
@@ -935,6 +944,8 @@ to load the custom bundle file instead.
 
 ### Features
 - Add ability to configure component preloads and custom bundles [`2241e5f`](https://github.com/SAP/ui5-builder/commit/2241e5ff98fd95f1f80cc74959655ae7a9c660e7)
+[v4.0.5]: https://github.com/SAP/ui5-builder/compare/v4.0.4...v4.0.5
+[v4.0.4]: https://github.com/SAP/ui5-builder/compare/v4.0.3...v4.0.4
 [v4.0.3]: https://github.com/SAP/ui5-builder/compare/v4.0.2...v4.0.3
 [v4.0.2]: https://github.com/SAP/ui5-builder/compare/v4.0.1...v4.0.2
 [v4.0.1]: https://github.com/SAP/ui5-builder/compare/v4.0.0...v4.0.1

package/lib/processors/jsdoc/lib/createIndexFiles.js

@@ -39,12 +39,12 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 		log.info("Using custom fs");
 	}
 	if (returnOutputFiles) {
-		log.info("Returning output files instead of writing to fs.")
+		log.info("Returning output files instead of writing to fs.");
 	}
 	log.info("");
 
 	// Deprecated, Experimental and Since collections
-	let oListCollection = {
+	const oListCollection = {
 		deprecated: {
 			noVersion: {
 				apis: []
@@ -63,13 +63,11 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 			fs.readFile(file, 'utf8', function (err, data) {
 				if (err) {
 					reject(err);
-				} else {
+				} else if (data.trim() === "") {
 					// Handle empty files scenario
-					if (data.trim() === "") {
-						resolve({});
-					} else {
-						resolve(JSON.parse(String(data)));
-					}
+					resolve({});
+				} else {
+					resolve(JSON.parse(String(data)));
 				}
 			});
 		});
@@ -102,20 +100,20 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 	 * Returns a promise that resolves with an array of symbols.
 	 */
 	function createSymbolSummaryForLib(lib) {
-		let file = path.join(unpackedTestresourcesRoot, lib.replace(/\./g, "/"), "designtime/api.json");
+		const file = path.join(unpackedTestresourcesRoot, lib.replace(/\./g, "/"), "designtime/api.json");
 
 		return readJSONFile(file).then(function (apijson) {
 			if (!apijson.hasOwnProperty("symbols") || !Array.isArray(apijson.symbols)) {
 				// Ignore libraries with invalid api.json content like empty object or non-array "symbols" property.
 				return [];
 			}
-			return apijson.symbols.map(symbol => {
-				let oReturn = {
+			return apijson.symbols.map((symbol) => {
+				const oReturn = {
 					name: symbol.name,
 					kind: symbol.kind,
 					visibility: symbol.visibility,
-					extends: symbol.extends,
-					implements: symbol.implements,
+					"extends": symbol.extends,
+					"implements": symbol.implements,
 					lib: lib
 				};
 				// We add deprecated member only when the control is deprecated to keep file size at check
@@ -132,7 +130,7 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 				collectLists(symbol);
 				return oReturn;
 			});
-		})
+		});
 	}
 
 	/*
@@ -146,7 +144,7 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 			const sText = oDataType !== "since" ? oEntityObject[oDataType].text : oEntityObject.description;
 			const oData = {
 					control: sSymbolName,
-					text: sText || undefined,
+					text: sText || undefined,
 					type: sObjectType,
 					"static": !!oEntityObject.static,
 					visibility: oEntityObject.visibility
@@ -159,7 +157,7 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 
 			if (sSince && sSince !== "undefined" /* Sometimes sSince comes as string "undefined" */) {
 				// take only major and minor versions
-				let sVersion = sSince.split(".").slice(0, 2).join(".");
+				const sVersion = sSince.split(".").slice(0, 2).join(".");
 
 				oData.since = sSince;
 
@@ -190,7 +188,7 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 		}
 
 		// Methods
-		oSymbol.methods && oSymbol.methods.forEach(oMethod => {
+		oSymbol.methods?.forEach((oMethod) => {
 			if (oMethod.deprecated) {
 				addData("deprecated", oMethod, "methods", oSymbol.name);
 			}
@@ -205,7 +203,7 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 		});
 
 		// Events
-		oSymbol.events && oSymbol.events.forEach(oEvent => {
+		oSymbol.events?.forEach((oEvent) => {
 			if (oEvent.deprecated) {
 				addData("deprecated", oEvent, "events", oSymbol.name);
 			}
@@ -229,24 +227,24 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 	}
 
 	function expandHierarchyInfo(symbols) {
-		let byName = new Map();
-		symbols.forEach(symbol => {
+		const byName = new Map();
+		symbols.forEach((symbol) => {
 			byName.set(symbol.name, symbol);
 		});
-		symbols.forEach(symbol => {
-			let parent = symbol.extends && byName.get(symbol.extends);
+		symbols.forEach((symbol) => {
+			const parent = symbol.extends && byName.get(symbol.extends);
 			if (parent) {
-				parent.extendedBy = parent.extendedBy ||  [];
+				parent.extendedBy = parent.extendedBy || [];
 				parent.extendedBy.push({
 					name: symbol.name,
 					visibility: symbol.visibility
 				});
 			}
 			if (symbol.implements) {
-				symbol.implements.forEach(intfName => {
-					let intf = byName.get(intfName);
+				symbol.implements.forEach((intfName) => {
+					const intf = byName.get(intfName);
 					if (intf) {
-						intf.implementedBy = intf.implementedBy ||  [];
+						intf.implementedBy = intf.implementedBy || [];
 						intf.implementedBy.push({
 							name: symbol.name,
 							visibility: symbol.visibility
@@ -259,23 +257,23 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 	}
 
 	function convertListToTree(symbols) {
-		let aTree = [];
+		const aTree = [];
 
 		// Filter out excluded libraries
 		symbols = symbols.filter(({lib}) => ["sap.ui.documentation"].indexOf(lib) === -1);
 
 		// Create treeName and displayName
-		symbols.forEach(oSymbol => {
+		symbols.forEach((oSymbol) => {
 			oSymbol.treeName = oSymbol.name.replace(/^module:/, "").replace(/\//g, ".");
 			oSymbol.displayName = oSymbol.treeName.split(".").pop();
 		});
 
 		// Create missing - virtual namespaces
-		symbols.forEach(oSymbol => {
+		symbols.forEach((oSymbol) => {
 			oSymbol.treeName.split(".").forEach((sPart, i, a) => {
-				let sName = a.slice(0, (i + 1)).join(".");
+				const sName = a.slice(0, (i + 1)).join(".");
 
-				if (!symbols.find(o => o.treeName === sName)) {
+				if (!symbols.find((o) => o.treeName === sName)) {
 					symbols.push({
 						name: sName,
 						treeName: sName,
@@ -289,13 +287,12 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 		});
 
 		// Discover parents
-		symbols.forEach(oSymbol => {
-			let aParent = oSymbol.treeName.split("."),
-				sParent;
+		symbols.forEach((oSymbol) => {
+			const aParent = oSymbol.treeName.split(".");
 
 			// Extract parent name
 			aParent.pop();
-			sParent = aParent.join(".");
+			const sParent = aParent.join(".");
 
 			// Mark parent
 			if (symbols.find(({treeName}) => treeName === sParent)) {
@@ -305,20 +302,20 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 
 		// Sort the list before building the tree
 		symbols.sort((a, b) => {
-			let sA = a.treeName.toUpperCase(),
+			const sA = a.treeName.toUpperCase(),
 				sB = b.treeName.toUpperCase();
 
-			if (sA < sB) return -1;
-			if (sA > sB) return 1;
+			if (sA < sB) {return -1;}
+			if (sA > sB) {return 1;}
 			return 0;
 		});
 
 		// Build tree
-		symbols.forEach(oSymbol => {
+		symbols.forEach((oSymbol) => {
 			if (oSymbol.parent) {
-				let oParent = symbols.find(({treeName}) => treeName === oSymbol.parent);
+				const oParent = symbols.find(({treeName}) => treeName === oSymbol.parent);
 
-				if (!oParent.nodes) oParent.nodes = [];
+				if (!oParent.nodes) {oParent.nodes = [];}
 				oParent.nodes.push(oSymbol);
 			} else {
 				aTree.push(oSymbol);
@@ -327,13 +324,13 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 
 		// Custom sort first level tree items - "sap" namespace should be on top
 		aTree.sort((a, b) => {
-			let sA = a.displayName.toUpperCase(),
+			const sA = a.displayName.toUpperCase(),
 				sB = b.displayName.toUpperCase();
 
-			if (sA === "SAP") return -1;
-			if (sB === "SAP") return 1;
-			if (sA < sB) return -1;
-			if (sA > sB) return 1;
+			if (sA === "SAP") {return -1;}
+			if (sB === "SAP") {return 1;}
+			if (sA < sB) {return -1;}
+			if (sA > sB) {return 1;}
 
 			return 0;
 		});
@@ -349,10 +346,10 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 			delete oSymbol.treeName;
 			delete oSymbol.parent;
 			if (oSymbol.nodes) {
-				oSymbol.nodes.forEach(o => cleanTree(o));
+				oSymbol.nodes.forEach((o) => cleanTree(o));
 			}
 		}
-		aTree.forEach(o => cleanTree(o));
+		aTree.forEach((o) => cleanTree(o));
 
 		return aTree;
 	}
@@ -401,7 +398,7 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 			propagateFlags(oSymbol, { bAllContentDeprecated: true });
 		} else {
 			// 3. If all children are deprecated, then the parent is marked as content-deprecated
-			oSymbol.bAllContentDeprecated = !!oSymbol.nodes && oSymbol.nodes.every(node => node.bAllContentDeprecated);
+			oSymbol.bAllContentDeprecated = !!oSymbol.nodes && oSymbol.nodes.every((node) => node.bAllContentDeprecated);
 		}
 	}
 
@@ -413,9 +410,9 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 	function propagateFlags(oSymbol, oFlags) {
 		Object.assign(oSymbol, oFlags);
 		if (oSymbol.nodes) {
-			oSymbol.nodes.forEach(node => {
+			oSymbol.nodes.forEach((node) => {
 				propagateFlags(node, oFlags);
-			})
+			});
 		}
 	}
 
@@ -424,11 +421,11 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 		const filesToReturn = {};
 
 		var p = readJSONFile(versionInfoFile)
-			.then(versionInfo => {
+			.then((versionInfo) => {
 				version = versionInfo.version;
 				return Promise.all(
 					versionInfo.libraries.map(
-						lib => createSymbolSummaryForLib(lib.name).catch(err => {
+						(lib) => createSymbolSummaryForLib(lib.name).catch((err) => {
 							// ignore 'file not found' errors as some libs don't have an api.json (themes, server libs)
 							if (err.code === 'ENOENT') {
 								return [];
@@ -441,8 +438,8 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 			.then(deepMerge)
 			.then(expandHierarchyInfo)
 			.then(convertListToTree)
-			.then(symbols => {
-				let result = {
+			.then((symbols) => {
+				const result = {
 					"$schema-ref": "http://schemas.sap.com/sapui5/designtime/api-index.json/1.0",
 					version: version,
 					library: "*",
@@ -456,13 +453,13 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 			})
 			.then(() => {
 				/* Lists - modify and cleanup */
-				let sortList = function (oList) {
+				const sortList = function (oList) {
 					/* Sorting since records */
-					let aKeys = Object.keys(oList),
+					const aKeys = Object.keys(oList),
 						oSorted = {};
 
 					aKeys.sort((a, b) => {
-						let aA = a.split("."),
+						const aA = a.split("."),
 							aB = b.split(".");
 
 						if (a === "noVersion") {
@@ -478,7 +475,7 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 						b = [aB[0], ('0' + aB[1]).slice(-2)].join("");
 
 						// Sort descending
-						return parseInt(b, 10) - parseInt(a, 10);
+						return parseInt(b) - parseInt(a);
 					});
 
 					aKeys.forEach((sKey) => {
@@ -529,8 +526,8 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 					]);
 				}
 			})
-			.catch(err => {
-				log.error("**** failed to create API index for libraries:", err)
+			.catch((err) => {
+				log.error("**** failed to create API index for libraries:", err);
 				throw err;
 			});