@ui5/builder 3.2.0 → 3.3.1

package/.reuse/dep5

@@ -25,9 +25,9 @@ Disclaimer: The code in this project may include calls to APIs (“API Calls”)
  parties the right to use of access any SAP External Product, through API Calls.
 
 Files: *
-Copyright: 2018-2023 SAP SE or an SAP affiliate company and UI5 Tooling contributors
+Copyright: 2018-2024 SAP SE or an SAP affiliate company and UI5 Tooling contributors
 License: Apache-2.0
 
 Files: lib/processors/jsdoc/lib/*
-Copyright: 2009-2023 SAP SE or an SAP affiliate company and OpenUI5 contributors
+Copyright: 2009-2024 SAP SE or an SAP affiliate company and OpenUI5 contributors
 License: Apache-2.0

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/v3.2.0...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-builder/compare/v3.3.1...HEAD).
+
+<a name="v3.3.1"></a>
+## [v3.3.1] - 2024-03-27
+
+<a name="v3.3.0"></a>
+## [v3.3.0] - 2024-01-18
+### Features
+- **flexChangesBundler:** Merge existing with new flexibility-bundle.json [`fd070ab`](https://github.com/SAP/ui5-builder/commit/fd070abaa22680ee70b448fa0ac406a8f2b57cc5)
+
 
 <a name="v3.2.0"></a>
 ## [v3.2.0] - 2023-12-12
@@ -851,6 +860,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)
+[v3.3.1]: https://github.com/SAP/ui5-builder/compare/v3.3.0...v3.3.1
+[v3.3.0]: https://github.com/SAP/ui5-builder/compare/v3.2.0...v3.3.0
 [v3.2.0]: https://github.com/SAP/ui5-builder/compare/v3.1.1...v3.2.0
 [v3.1.1]: https://github.com/SAP/ui5-builder/compare/v3.1.0...v3.1.1
 [v3.1.0]: https://github.com/SAP/ui5-builder/compare/v3.0.9...v3.1.0

package/CONTRIBUTING.md

@@ -1,3 +1,3 @@
 # Contributing to the UI5 Tooling
 
-See CONTRIBUTING.md in the [SAP/ui5-tooling](https://github.com/SAP/ui5-tooling/blob/main/CONTRIBUTING.md) repository.
+See CONTRIBUTING.md in the [SAP/ui5-tooling](https://github.com/SAP/ui5-tooling/blob/v3/CONTRIBUTING.md) repository.

package/LICENSE.txt

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2018-2023 SAP SE or an SAP affiliate company and UI5 Tooling contributors
+   Copyright 2018-2024 SAP SE or an SAP affiliate company and UI5 Tooling contributors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -1,11 +1,11 @@
-![UI5 icon](https://raw.githubusercontent.com/SAP/ui5-tooling/main/docs/images/UI5_logo_wide.png)
+![UI5 icon](https://raw.githubusercontent.com/SAP/ui5-tooling/v3/docs/images/UI5_logo_wide.png)
 
 # ui5-builder
 > Modules for building UI5 projects  
 > Part of the [UI5 Tooling](https://github.com/SAP/ui5-tooling)
 
 [![REUSE status](https://api.reuse.software/badge/github.com/SAP/ui5-builder)](https://api.reuse.software/info/github.com/SAP/ui5-builder)
-[![Build Status](https://dev.azure.com/sap/opensource/_apis/build/status/SAP.ui5-builder?branchName=main)](https://dev.azure.com/sap/opensource/_build/latest?definitionId=26&branchName=main)
+[![Build Status](https://dev.azure.com/sap/opensource/_apis/build/status/SAP.ui5-builder?branchName=v3)](https://dev.azure.com/sap/opensource/_build/latest?definitionId=26&branchName=v3)
 [![npm Package Version](https://badge.fury.io/js/%40ui5%2Fbuilder.svg)](https://www.npmjs.com/package/@ui5/builder)
 [![Coverage Status](https://coveralls.io/repos/github/SAP/ui5-builder/badge.svg)](https://coveralls.io/github/SAP/ui5-builder)
 
@@ -15,10 +15,10 @@ UI5 Builder documentation can be found here: [sap.github.io/ui5-tooling](https:/
 The UI5 Builder API Reference can be found here: [`@ui5/builder`](https://sap.github.io/ui5-tooling/v3/api/)
 
 ## Contributing
-Please check our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/main/CONTRIBUTING.md).
+Please check our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/v3/CONTRIBUTING.md).
 
 ## Support
-Please follow our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/main/CONTRIBUTING.md#report-an-issue) on how to report an issue.
+Please follow our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/v3/CONTRIBUTING.md#report-an-issue) on how to report an issue.
 
 Please report issues in the main [UI5 Tooling](https://github.com/SAP/ui5-tooling) repository.
 

package/lib/processors/bundlers/flexChangesBundler.js

@@ -20,9 +20,11 @@ import {createResource} from "@ui5/fs/resourceFactory";
  * @param {string} parameters.options.pathPrefix Prefix for bundle path
  * @param {string} parameters.options.hasFlexBundleVersion true if minUI5Version >= 1.73 than
  *															create flexibility-bundle.json
+ * @param {object} [parameters.existingFlexBundle={}] Object with existing flexibility-bundle.json
+ * 															to merge with new changes
  * @returns {Promise<@ui5/fs/Resource[]>} Promise resolving with flex changes bundle resources
  */
-export default function({resources, options: {pathPrefix, hasFlexBundleVersion}}) {
+export default function({resources, options: {pathPrefix, hasFlexBundleVersion}, existingFlexBundle = {}}) {
 	let bundleName = "changes-bundle.json";
 
 	function sortByTimeStamp(a, b) {
@@ -86,7 +88,7 @@ export default function({resources, options: {pathPrefix, hasFlexBundleVersion}}
 			return JSON.stringify(changes);
 		} else {
 			bundleName = "flexibility-bundle.json";
-			const newChangeFormat = {
+			let newChangeFormat = {
 				changes,
 				compVariants,
 				variants,
@@ -94,11 +96,33 @@ export default function({resources, options: {pathPrefix, hasFlexBundleVersion}}
 				variantDependentControlChanges,
 				variantManagementChanges
 			};
-
+			if (Object.keys(existingFlexBundle).length > 0) {
+				newChangeFormat = mergeFlexChangeBundles(newChangeFormat);
+			}
 			return JSON.stringify(newChangeFormat);
 		}
 	}
 
+	/**
+	 * Merge new and existing bundles
+	 *
+	 * @param {object} newFlexBundle Object with new content of flexibility-bundle.json
+	 * @returns {object} Object with merged content of new and existing flexibility-bundle.json
+	 */
+	function mergeFlexChangeBundles(newFlexBundle) {
+		const result = {};
+
+		Object.keys(newFlexBundle).forEach((key) => {
+			if (existingFlexBundle[key] && Array.isArray(existingFlexBundle[key])) {
+				result[key] = existingFlexBundle[key].concat(newFlexBundle[key]);
+			} else {
+				result[key] = newFlexBundle[key];
+			}
+		});
+
+		return result;
+	}
+
 	return Promise.all(resources.map((resource) => {
 		return resource.getBuffer().then((buffer) => {
 			return JSON.parse(buffer.toString());

package/lib/processors/jsdoc/lib/createIndexFiles.cjs

@@ -1,7 +1,7 @@
 /*
  * Node script to create cross-library API index files for use in the UI5 SDKs.
  *
- * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -122,6 +122,13 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 				if (symbol.deprecated) {
 					oReturn.deprecated = true;
 				}
+
+				if (symbol.experimental && !symbol.deprecated) {
+					oReturn.experimental = true;
+				} else {
+					oReturn.experimental = false;
+				}
+
 				collectLists(symbol);
 				return oReturn;
 			});
@@ -230,14 +237,20 @@ function createIndexFiles(versionInfoFile, unpackedTestresourcesRoot, targetFile
 			let parent = symbol.extends && byName.get(symbol.extends);
 			if (parent) {
 				parent.extendedBy = parent.extendedBy ||  [];
-				parent.extendedBy.push(symbol.name);
+				parent.extendedBy.push({
+					name: symbol.name,
+					visibility: symbol.visibility
+				});
 			}
 			if (symbol.implements) {
 				symbol.implements.forEach(intfName => {
 					let intf = byName.get(intfName);
 					if (intf) {
 						intf.implementedBy = intf.implementedBy ||  [];
-						intf.implementedBy.push(symbol.name);
+						intf.implementedBy.push({
+							name: symbol.name,
+							visibility: symbol.visibility
+						});
 					}
 				});
 			}

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

@@ -1,7 +1,7 @@
 /*
  * Node script to preprocess api.json files for use in the UI5 SDKs.
  *
- * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -32,6 +32,10 @@ function replaceLastPathSegment(p, replacement) {
 	return path.join(path.dirname(p), replacement);
 }
 
+function normalizeToUI5GlobalNotation(sModuleName){
+	return sModuleName.replace(/\//g, ".");
+}
+
 /*
  * Transforms the api.json as created by the JSDoc build into a pre-processed api.json file suitable for the SDK.
  *
@@ -146,7 +150,7 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 			symbols.forEach(oSymbol => {
 				let sModuleClearName = oSymbol.name.replace(/^module:/, "");
 				oSymbol.displayName = sModuleClearName;
-				oSymbol.treeName = sModuleClearName.replace(/\//g, ".");
+				oSymbol.treeName = normalizeToUI5GlobalNotation(sModuleClearName);
 			});
 
 			// Create missing - virtual namespaces
@@ -229,7 +233,7 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 		oData.symbols.forEach((oSymbol) => {
 
 			// when the module name starts with the library name, then we apply the default component
-			if (oSymbol.name.indexOf(oData.library) === 0) {
+			if (normalizeToUI5GlobalNotation(oSymbol.displayName).startsWith(oData.library)) {
 				oSymbol.component = oChainObject.defaultComponent;
 			}
 
@@ -237,7 +241,7 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 			// Note: Last hit wins as there may be a more specific component pattern
 			if (oChainObject.customSymbolComponents) {
 				Object.keys(oChainObject.customSymbolComponents).forEach(sComponent => {
-					if (matchComponent(oSymbol.name, sComponent)) {
+					if (matchComponent(normalizeToUI5GlobalNotation(oSymbol.displayName), sComponent)) {
 						oSymbol.component = oChainObject.customSymbolComponents[sComponent];
 					}
 				});
@@ -371,6 +375,21 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 						oProperty.description = formatters.formatDescription(oProperty.description);
 					}
 
+					// Examples
+					if (oProperty.examples) {
+						oProperty.examples.forEach((oExample) => {
+							oExample.data = formatters.formatExample(oExample.caption, oExample.text);
+
+							// Keep file size in check
+							if (oExample.caption) {
+								delete oExample.caption;
+							}
+							if (oExample.text) {
+								delete oExample.text;
+							}
+						});
+					}
+
 					// Type
 					if (oSymbol.kind !== "enum") { // enum properties don't have an own type
 						if (oProperty.type) {
@@ -2016,7 +2035,12 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 		formatReferencesInDescription: function(oEntity) {
 			if (oEntity.references && Array.isArray(oEntity.references)) {
 				oEntity.references = oEntity.references.map(sReference => {
-					return `<li>${sReference}</li>`;
+					if (/{@link.*}/.test(sReference)) {
+						return "<li>" + sReference + "</li>";
+					} else {
+						return "<li>{@link " + sReference + "}</li>";
+
+					};
 				});
 				if (!oEntity.description) {
 					// If there is no method description - references should be the first line of it

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

@@ -1,7 +1,7 @@
 /*
  * JSDoc3 plugin for UI5 documentation generation.
  *
- * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

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

@@ -1,7 +1,7 @@
 /*
  * JSDoc3 template for UI5 documentation generation.
  *
- * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -2466,6 +2466,10 @@ function postProcessAPIJSON(api) {
 	}
 
 	symbols.forEach((symbol) => {
+		// add note for enums which are not exposed by their name
+		if (symbol.kind === "enum" && symbol.export) {
+			symbol.description += `\n\nThis enum is part of the '${symbol.module}' module export and must be accessed by the property '${symbol.export}'.`;
+		}
 		if ( !symbol["ui5-metadata"] ) {
 			return;
 		}

package/lib/tasks/bundlers/generateFlexChangesBundle.js

@@ -83,15 +83,21 @@ export default async function({workspace, taskUtil, options = {}}) {
 	if (allResources.length > 0) {
 		const version = semver.coerce(await readManifestMinUI5Version());
 		let hasFlexBundleVersion = false;
+		let flexBundle = {};
 		if (semver.compare(version, "1.73.0") >= 0) {
 			hasFlexBundleVersion = true;
+			const flexBundleResource = await workspace.byPath(`${pathPrefix}/changes/flexibility-bundle.json`);
+			if (flexBundleResource) {
+				flexBundle = JSON.parse(await flexBundleResource.getString());
+			}
 		}
 		const processedResources = await flexChangesBundler({
 			resources: allResources,
 			options: {
 				pathPrefix,
 				hasFlexBundleVersion
-			}
+			},
+			existingFlexBundle: flexBundle
 		});
 		await Promise.all(processedResources.map((resource) => {
 			log.verbose("Writing flexibility changes bundle");

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ui5/builder",
-	"version": "3.2.0",
+	"version": "3.3.1",
 	"description": "UI5 Tooling - Builder",
 	"author": {
 		"name": "SAP SE",
@@ -130,27 +130,27 @@
 		"less-openui5": "^0.11.6",
 		"pretty-data": "^0.40.0",
 		"rimraf": "^5.0.5",
-		"semver": "^7.5.4",
-		"terser": "^5.26.0",
+		"semver": "^7.6.0",
+		"terser": "^5.29.2",
 		"workerpool": "^6.5.1",
 		"xml2js": "^0.6.2"
 	},
 	"devDependencies": {
 		"@istanbuljs/esm-loader-hook": "^0.2.0",
-		"@jridgewell/trace-mapping": "^0.3.20",
-		"@ui5/project": "^3.8.0",
+		"@jridgewell/trace-mapping": "^0.3.25",
+		"@ui5/project": "^3.9.0",
 		"ava": "^5.3.1",
-		"chai": "^4.3.10",
+		"chai": "^4.4.1",
 		"chai-fs": "^2.0.0",
 		"chokidar-cli": "^3.0.0",
 		"cross-env": "^7.0.3",
 		"depcheck": "^1.4.7",
 		"docdash": "^2.0.2",
-		"eslint": "^8.55.0",
+		"eslint": "^8.57.0",
 		"eslint-config-google": "^0.14.0",
 		"eslint-plugin-ava": "^14.0.0",
-		"eslint-plugin-jsdoc": "^46.9.0",
-		"esmock": "^2.6.0",
+		"eslint-plugin-jsdoc": "^46.10.1",
+		"esmock": "^2.6.4",
 		"line-column": "^1.0.2",
 		"nyc": "^15.1.0",
 		"open-cli": "^7.2.0",