@ui5/builder 3.5.0 → 3.5.1

package/CHANGELOG.md

@@ -2,10 +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/v3.5.0...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-builder/compare/v3.5.1...HEAD).
+
+<a name="v3.5.1"></a>
+## [v3.5.1] - 2024-07-22
+### Bug Fixes
+- **generateThemeDesignerResources:** Allow core .theming in sources ([#1062](https://github.com/SAP/ui5-builder/issues/1062)) [`dda3011`](https://github.com/SAP/ui5-builder/commit/dda30114461314e81da43bd739e709186744f592)
+
 
 <a name="v3.5.0"></a>
-## [v3.5.0] - 2024-06-21
+## [v3.5.0] - 2024-06-24
 ### Features
 - ES2023 Support [`097049d`](https://github.com/SAP/ui5-builder/commit/097049daeec5c54c2d5e858b12e0c54c826ff663)
 
@@ -878,6 +884,7 @@ 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)
+[v3.5.1]: https://github.com/SAP/ui5-builder/compare/v3.5.0...v3.5.1
 [v3.5.0]: https://github.com/SAP/ui5-builder/compare/v3.4.1...v3.5.0
 [v3.4.1]: https://github.com/SAP/ui5-builder/compare/v3.4.0...v3.4.1
 [v3.4.0]: https://github.com/SAP/ui5-builder/compare/v3.3.1...v3.4.0

package/lib/processors/jsdoc/lib/transformApiJson.cjs

@@ -132,7 +132,7 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 		 * @returns {boolean}
 		 */
 		function possibleUI5Symbol(sName) {
-			return /^[a-zA-Z][a-zA-Z.]*[a-zA-Z]$/.test(sName);
+			return /^[a-zA-Z][a-zA-Z0-9.]*[a-zA-Z0-9]$/.test(sName);
 		}
 
 		// Function is a copy from: LibraryInfo.js => LibraryInfo.prototype._getActualComponent => "match" inline method

package/lib/processors/jsdoc/lib/ui5/plugin.cjs

@@ -1145,21 +1145,29 @@ function collectVisibilityInfo(settings, doclet, className, n) {
 	let visibility = (settings.visibility && settings.visibility.value.value) || "public";
 
 	if (!validVisibilities.has(visibility)) {
-		future(`${className}: Invalid visibility '${visibility}' in runtime metadata defined for managed setting '${n}. Valid options are ${Array.from(validVisibilities).join(', ')}.`);
+		error(`${className}: Invalid visibility '${visibility}' in runtime metadata defined for managed setting '${n}. Valid options are ${Array.from(validVisibilities).join(', ')}.`);
 	}
 
 	if (doclet?.access) {
-		const access = doclet.access;
+		let access = doclet.access;
 
 		if (!validAccesses.has(access)) {
-			future(`${className}: Invalid JSDoc visibility '${access}' defined for managed setting '${n}'. Valid options are ${Array.from(validAccesses).join(', ')}.`);
+			error(`${className}: Invalid JSDoc visibility '${access}' defined for managed setting '${n}'. Valid options are ${Array.from(validAccesses).join(', ')}.`);
 		}
 
 		if (visibility === 'hidden' && (access === 'public' || access === 'protected' || access === 'restricted')) {
-			future(`${className}: Inconsistent visibility settings detected. Runtime metadata sets visibility to '${visibility}', while JSDoc defines it as '${access}' for the managed setting '${n}'.`);
+			// force access to private to avoid inconsistencies in libraries that ignore JSDoc errors
+			error(`${className}: Inconsistent visibility settings detected. Runtime metadata sets visibility to '${visibility}', while JSDoc defines it as '${access}' for the managed setting '${n}'. Forcing visibility to 'hidden'.`);
+			access = "private";
 		}
 		if (visibility === 'public' && access === 'private') {
-			future(`${className}: Inconsistent visibility settings detected. Runtime metadata sets visibility to '${visibility}', while JSDoc defines it as '${access}' for the managed setting '${n}'.`);
+			// force access to 'restricted' to avoid inconsistencies in libraries that ignore JSDoc errors
+			ui5data(doclet).stakeholders ??= [];
+			if ( !doclet.__ui5.stakeholders.includes(className) ) {
+				doclet.__ui5.stakeholders.push(className);
+			}
+			error(`${className}: Inconsistent visibility settings detected. Runtime metadata sets visibility to '${visibility}', while JSDoc defines it as '${access}' for the managed setting '${n}'. Forcing visibility to 'restricted'.`);
+			access = "restricted";
 		}
 
 		if (visibility == "public" && (access === "restricted" || access === "protected")) {
@@ -2678,7 +2686,14 @@ exports.defineTags = function(dictionary) {
 			}
 		}
 	});
-
+	dictionary.defineTag('ui5-module-override', {
+		onTagged: function(doclet, tag) {
+			if ( tag.value ) {
+				const args = tag.value.trim().split(/\s+/);
+				ui5data(doclet).moduleOverride = [ args[0], args[1] ?? ""];
+			}
+		}
+	});
 	/**
 	 * Mark a doclet as synthetic.
 	 *
@@ -2857,6 +2872,11 @@ exports.handlers = {
 				debug("found matching local declaration", e.doclet.longname, "'" + localDecl.export + "'", currentModule.defaultExport);
 				_ui5data.export = localDecl.export;
 			}
+			if ( _ui5data.moduleOverride ) {
+				_ui5data.resource = _ui5data.moduleOverride[0] + ".js";
+				_ui5data.module = _ui5data.moduleOverride[0];
+				_ui5data.export = _ui5data.moduleOverride[1];
+			}
 		}
 
 

package/lib/processors/jsdoc/lib/ui5/template/publish.cjs

@@ -2308,7 +2308,7 @@ function createAPIJSON4Symbol(symbol, omitDefaults) {
 		if ( symbol.__ui5.stereotype !== 'xmlmacro' && ownMethods.length > 0 ) {
 			collection("methods");
 			ownMethods.forEach(function(member) {
-				writeMethod(member, undefined, symbol.kind === 'interface');
+				writeMethod(member, undefined, symbol.kind === 'interface' || symbol.kind === 'class');
 				if ( member.__ui5.members ) {
 					// HACK: export nested static functions as siblings of the current function
 					// A correct representation has to be discussed with the SDK / WebIDE

package/lib/tasks/generateThemeDesignerResources.js

@@ -2,6 +2,7 @@ import posixPath from "node:path/posix";
 import {getLogger} from "@ui5/logger";
 const log = getLogger("builder:tasks:generateThemeDesignerResources");
 import libraryLessGenerator from "../processors/libraryLessGenerator.js";
+import {updateLibraryDotTheming} from "./utils/dotTheming.js";
 import ReaderCollectionPrioritized from "@ui5/fs/ReaderCollectionPrioritized";
 import Resource from "@ui5/fs/Resource";
 import fsInterface from "@ui5/fs/fsInterface";
@@ -44,6 +45,10 @@ function generateLibraryDotTheming({namespace, version, hasThemes}) {
 		sVersion: version
 	};
 
+	// Note that with sap.ui.core version 1.127.0 the .theming file has been put into
+	// the library sources so that "aFiles" can be maintained from there.
+	// The below configuration is still needed for older versions of sap.ui.core which do not
+	// contain the file.
 	if (namespace === "sap/ui/core") {
 		dotTheming.aFiles = [
 			"library",
@@ -241,12 +246,33 @@ export default async function({workspace, dependencies, options}) {
 	// Only for type "library". Type "theme-library" does not provide a namespace
 	// Also needs to be created in case a library does not have any themes (see bIgnore flag)
 	if (namespace) {
-		log.verbose(`Generating .theming for namespace ${namespace}`);
-		const libraryDotThemingResource = generateLibraryDotTheming({
-			namespace,
-			version,
-			hasThemes
-		});
+		let libraryDotThemingResource;
+
+		// Do not generate a .theming file for the sap.ui.core library
+		if (namespace === "sap/ui/core") {
+			// Check if the .theming file already exists
+			libraryDotThemingResource = await workspace.byPath(`/resources/${namespace}/.theming`);
+			if (libraryDotThemingResource) {
+				// Update the existing .theming resource
+				log.verbose(`Updating .theming for namespace ${namespace}`);
+				await updateLibraryDotTheming({
+					resource: libraryDotThemingResource,
+					namespace,
+					version,
+					hasThemes
+				});
+			}
+		}
+
+		if (!libraryDotThemingResource) {
+			log.verbose(`Generating .theming for namespace ${namespace}`);
+			libraryDotThemingResource = generateLibraryDotTheming({
+				namespace,
+				version,
+				hasThemes
+			});
+		}
+
 		await workspace.write(libraryDotThemingResource);
 	}
 

package/lib/tasks/utils/dotTheming.js

@@ -0,0 +1,33 @@
+export async function updateLibraryDotTheming({resource, namespace, version, hasThemes}) {
+	const dotTheming = JSON.parse(await resource.getString());
+
+	if (!dotTheming.sEntity) {
+		throw new Error(`Missing 'sEntity' property in ${resource.getPath()}`);
+	}
+
+	if (dotTheming.sEntity !== "Library") {
+		throw new Error(
+			`Incorrect 'sEntity' value '${dotTheming.sEntity}' in ${resource.getPath()}: ` +
+			`Expected 'Library'`
+		);
+	}
+
+	if (!dotTheming.sId) {
+		throw new Error(`Missing 'sId' property in ${resource.getPath()}`);
+	}
+
+	if (dotTheming.sId !== namespace) {
+		throw new Error(`Incorrect 'sId' value '${dotTheming.sId}' in ${resource.getPath()}: Expected '${namespace}'`);
+	}
+
+	dotTheming.sVersion = version;
+
+	if (!hasThemes) {
+		// Set ignore flag when there are no themes at all
+		// This is important in case a library used to contain themes that have been removed
+		// in a later version of the library.
+		dotTheming.bIgnore = true;
+	}
+
+	resource.setString(JSON.stringify(dotTheming, null, 2));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ui5/builder",
-	"version": "3.5.0",
+	"version": "3.5.1",
 	"description": "UI5 Tooling - Builder",
 	"author": {
 		"name": "SAP SE",
@@ -22,6 +22,7 @@
 		"./processors/jsdoc/lib/*": null,
 		"./tasks/*": "./lib/tasks/*.js",
 		"./tasks/taskRepository": null,
+		"./tasks/utils/*": null,
 		"./tasks/bundlers/utils/*": null,
 		"./package.json": "./package.json",
 		"./internal/taskRepository": "./lib/tasks/taskRepository.js",
@@ -118,7 +119,7 @@
 		"url": "git@github.com:SAP/ui5-builder.git"
 	},
 	"dependencies": {
-		"@jridgewell/sourcemap-codec": "^1.4.15",
+		"@jridgewell/sourcemap-codec": "^1.5.0",
 		"@ui5/fs": "^3.0.5",
 		"@ui5/logger": "^3.0.0",
 		"cheerio": "1.0.0-rc.12",
@@ -129,16 +130,16 @@
 		"jsdoc": "^4.0.3",
 		"less-openui5": "^0.11.6",
 		"pretty-data": "^0.40.0",
-		"rimraf": "^5.0.7",
-		"semver": "^7.6.2",
-		"terser": "^5.31.1",
+		"rimraf": "^5.0.9",
+		"semver": "^7.6.3",
+		"terser": "^5.31.3",
 		"workerpool": "^6.5.1",
 		"xml2js": "^0.6.2"
 	},
 	"devDependencies": {
 		"@istanbuljs/esm-loader-hook": "^0.2.0",
 		"@jridgewell/trace-mapping": "^0.3.25",
-		"@ui5/project": "^3.9.1",
+		"@ui5/project": "^3.9.2",
 		"ava": "^5.3.1",
 		"chai": "^4.4.1",
 		"chai-fs": "^2.0.0",
@@ -150,7 +151,7 @@
 		"eslint-config-google": "^0.14.0",
 		"eslint-plugin-ava": "^14.0.0",
 		"eslint-plugin-jsdoc": "^46.10.1",
-		"esmock": "^2.6.6",
+		"esmock": "^2.6.7",
 		"line-column": "^1.0.2",
 		"nyc": "^15.1.0",
 		"open-cli": "^7.2.0",