@ui5/builder 3.5.1 → 4.0.1

package/lib/tasks/bundlers/generateLibraryPreload.js

@@ -1,6 +1,7 @@
 import {getLogger} from "@ui5/logger";
 const log = getLogger("builder:tasks:bundlers:generateLibraryPreload");
 import moduleBundler from "../../processors/bundlers/moduleBundler.js";
+import {applyDefaultsToBundleDefinition} from "./utils/applyDefaultsToBundleDefinition.js";
 import {negateFilters} from "../../lbt/resources/ResourceFilterList.js";
 import createModuleNameMapping from "./utils/createModuleNameMapping.js";
 
@@ -34,9 +35,9 @@ function getDefaultLibraryPreloadFilters(namespace, excludes) {
 function getBundleDefinition(namespace, excludes) {
 	// Note: This configuration is only used when no bundle definition in ui5.yaml exists (see "skipBundles" parameter)
 
-	// TODO: Remove this hardcoded bundle definition.
+	// TODO: Remove this hardcoded bundle definition once support for relevant versions has ended.
 	// sap.ui.core ui5.yaml contains a configuration since UI5 1.103.0 (specVersion 2.4)
-	// so this is still required to build UI5 versions <= 1.102.0.
+	// so this is still required to build UI5 versions <= 1.102.0 (such as 1.84 and 1.96)
 	if (namespace === "sap/ui/core") {
 		return {
 			name: `${namespace}/library-preload.js`,
@@ -164,8 +165,7 @@ function getModuleBundlerOptions(config) {
 	moduleBundlerOptions.bundleOptions = {
 		optimize: config.preload,
 		decorateBootstrapModule: config.preload,
-		addTryCatchRestartWrapper: config.preload,
-		usePredefineCalls: config.preload
+		addTryCatchRestartWrapper: config.preload
 	};
 
 	moduleBundlerOptions.bundleDefinition = getSapUiCoreBunDef(config.name, config.filters, config.preload);
@@ -256,12 +256,18 @@ export default async function({workspace, taskUtil, options: {skipBundles = [],
 			}
 		});
 	}
-
+	const coreVersion = taskUtil?.getProject("sap.ui.core")?.getVersion();
+	const allowStringBundling = taskUtil?.getProject().getSpecVersion().lt("4.0");
 	const execModuleBundlerIfNeeded = ({options, resources}) => {
 		if (skipBundles.includes(options.bundleDefinition.name)) {
 			log.verbose(`Skipping generation of bundle ${options.bundleDefinition.name}`);
 			return null;
 		}
+		if (coreVersion) {
+			options.targetUi5CoreVersion = coreVersion;
+		}
+		options.bundleDefinition = applyDefaultsToBundleDefinition(options.bundleDefinition, taskUtil);
+		options.allowStringBundling = allowStringBundling;
 		return moduleBundler({options, resources});
 	};
 
@@ -390,7 +396,6 @@ export default async function({workspace, taskUtil, options: {skipBundles = [],
 									bundleDefinition: getBundleDefinition(libraryNamespace, excludes),
 									bundleOptions: {
 										optimize: true,
-										usePredefineCalls: true,
 										ignoreMissingModules: true
 									}
 								},
@@ -401,7 +406,6 @@ export default async function({workspace, taskUtil, options: {skipBundles = [],
 									bundleDefinition: getDesigntimeBundleDefinition(libraryNamespace),
 									bundleOptions: {
 										optimize: true,
-										usePredefineCalls: true,
 										ignoreMissingModules: true,
 										skipIfEmpty: true
 									}
@@ -413,7 +417,6 @@ export default async function({workspace, taskUtil, options: {skipBundles = [],
 									bundleDefinition: getSupportFilesBundleDefinition(libraryNamespace),
 									bundleOptions: {
 										optimize: false,
-										usePredefineCalls: true,
 										ignoreMissingModules: true,
 										skipIfEmpty: true
 									}

package/lib/tasks/bundlers/generateStandaloneAppBundle.js

@@ -2,6 +2,7 @@ import {getLogger} from "@ui5/logger";
 const log = getLogger("builder:tasks:bundlers:generateStandaloneAppBundle");
 import ReaderCollectionPrioritized from "@ui5/fs/ReaderCollectionPrioritized";
 import moduleBundler from "../../processors/bundlers/moduleBundler.js";
+import {applyDefaultsToBundleDefinition} from "./utils/applyDefaultsToBundleDefinition.js";
 import createModuleNameMapping from "./utils/createModuleNameMapping.js";
 
 function getBundleDefinition(config) {
@@ -83,8 +84,8 @@ function getBundleDefinition(config) {
  */
 export default async function({workspace, dependencies, taskUtil, options}) {
 	const {projectName} = options;
-	// Backward compatibility: "namespace" option got renamed to "projectNamespace"
-	const namespace = options.projectNamespace || options.namespace;
+	const namespace = options.projectNamespace;
+	const coreVersion = taskUtil?.getProject("sap.ui.core")?.getVersion();
 
 	if (!namespace) {
 		log.warn(`Namespace of project ${projectName} is not known. Self contained bundling is currently ` +
@@ -138,31 +139,49 @@ export default async function({workspace, dependencies, taskUtil, options}) {
 		});
 	}
 
+	const allowStringBundling = taskUtil?.getProject().getSpecVersion().lt("4.0");
+	const bundleOptions = {
+		bundleDefinition: applyDefaultsToBundleDefinition(
+			getBundleDefinition({
+				name: "sap-ui-custom.js",
+				filters,
+				namespace,
+				preloadSection: true,
+			}),
+			taskUtil
+		),
+		allowStringBundling
+	};
+
+	const bundleDbgOptions = {
+		bundleDefinition: applyDefaultsToBundleDefinition(
+			getBundleDefinition({
+				name: "sap-ui-custom-dbg.js",
+				filters,
+				namespace,
+			}),
+			taskUtil
+		),
+		bundleOptions: {
+			optimize: false,
+		},
+		moduleNameMapping: unoptimizedModuleNameMapping,
+		allowStringBundling
+	};
+
+	if (coreVersion) {
+		bundleOptions.targetUi5CoreVersion = coreVersion;
+		bundleDbgOptions.targetUi5CoreVersion = coreVersion;
+	}
+
 	await Promise.all([
 		moduleBundler({
 			resources,
-			options: {
-				bundleDefinition: getBundleDefinition({
-					name: "sap-ui-custom.js",
-					filters,
-					namespace,
-					preloadSection: true
-				})
-			}
+			options: bundleOptions
 		}),
 		moduleBundler({
 			resources: unoptimizedResources,
-			options: {
-				bundleDefinition: getBundleDefinition({
-					name: "sap-ui-custom-dbg.js",
-					filters,
-					namespace
-				}),
-				bundleOptions: {
-					optimize: false
-				},
-				moduleNameMapping: unoptimizedModuleNameMapping
-			}
+			options: bundleDbgOptions
 		})
 	]).then((results) => {
 		const bundles = Array.prototype.concat.apply([], results);

package/lib/tasks/bundlers/utils/applyDefaultsToBundleDefinition.js

@@ -0,0 +1,35 @@
+/**
+ * Applies default values to bundleDefinitions
+ *
+ * @param {module:@ui5/builder/processors/bundlers/moduleBundler~ModuleBundleDefinition} bundleDefinition Module
+ *		bundle definition
+ * @param {@ui5/project/build/helpers/TaskUtil|object} [taskUtil] TaskUtil
+ *
+ * @returns {module:@ui5/builder/processors/bundlers/moduleBundler~ModuleBundleDefinition}
+ */
+export function applyDefaultsToBundleDefinition(bundleDefinition, taskUtil) {
+	bundleDefinition.sections = bundleDefinition?.sections?.map((section) => {
+		const defaultValues = {
+			resolve: false,
+			resolveConditional: false,
+			renderer: false,
+			sort: true,
+			declareRawModules: false,
+		};
+
+		// Since specVersion: 4.0 "require" section starts loading asynchronously.
+		// If specVersion cannot be determined, the latest spec is taken into account.
+		// This is a breaking change in specVersion: 4.0
+		if (section.mode === "require") {
+			// Builder.js already treats missing async flag as truthy value and builds asynchronously by default
+
+			if (taskUtil && taskUtil.getProject().getSpecVersion().lt("4.0")) {
+				defaultValues.async = false;
+			}
+		}
+
+		return Object.assign(defaultValues, section);
+	});
+
+	return bundleDefinition;
+}

package/lib/tasks/enhanceManifest.js

@@ -0,0 +1,32 @@
+import manifestEnhancer from "../processors/manifestEnhancer.js";
+import fsInterface from "@ui5/fs/fsInterface";
+
+/* eslint "jsdoc/check-param-names": ["error", {"disableExtraPropertyReporting":true}] */
+/**
+ * Task for transforming the manifest.json file.
+ * Adds missing information based on the available project resources,
+ * for example the locales supported by the present i18n resources.
+ *
+ * @public
+ * @function default
+ * @static
+ *
+ * @param {object} parameters Parameters
+ * @param {@ui5/fs/DuplexCollection} parameters.workspace DuplexCollection to read and write files
+ * @param {object} parameters.options Options
+ * @param {string} parameters.options.projectNamespace Namespace of the application
+ * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
+ */
+export default async function({workspace, options}) {
+	const {projectNamespace} = options;
+
+	// Note: all "manifest.json" files in the given namespace
+	const resources = await workspace.byGlob(`/resources/${projectNamespace}/**/manifest.json`);
+
+	const processedResources = await manifestEnhancer({
+		resources,
+		fs: fsInterface(workspace),
+	});
+
+	await Promise.all(processedResources.map((resource) => workspace.write(resource)));
+}

package/lib/tasks/generateCachebusterInfo.js

@@ -51,8 +51,7 @@ function getSigner(type) {
  */
 export default function({workspace, options}) {
 	const {signatureType} = options;
-	// Backward compatibility: "namespace" option got renamed to "projectNamespace"
-	const namespace = options.projectNamespace || options.namespace;
+	const namespace = options.projectNamespace;
 
 	const basePath = `/resources/${namespace}/`;
 	return workspace.byGlob(`/resources/${namespace}/**/*`)

package/lib/tasks/generateThemeDesignerResources.js

@@ -221,8 +221,7 @@ async function generateCssVariablesLess({workspace, combo, namespace}) {
  */
 export default async function({workspace, dependencies, options}) {
 	const {projectName, version} = options;
-	// Backward compatibility: "namespace" option got renamed to "projectNamespace"
-	const namespace = options.projectNamespace || options.namespace;
+	const namespace = options.projectNamespace;
 
 	// Skip sap.ui.documentation since it is not intended to be available in SAP Theme Designer to create custom themes
 	if (namespace === "sap/ui/documentation") {

package/lib/tasks/generateVersionInfo.js

@@ -23,7 +23,9 @@ const MANIFEST_JSON = "manifest.json";
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
 export default async ({workspace, dependencies, options: {rootProject, pattern}}) => {
-	const resources = await dependencies.byGlob(pattern);
+	let resources = await dependencies.byGlob(pattern);
+
+	resources = resources.filter((res) => res.getProject()?.getType() === "library");
 
 	const libraryInfosPromises = resources.map((dotLibResource) => {
 		const namespace = dotLibResource.getProject().getNamespace();

package/lib/tasks/taskRepository.js

@@ -17,6 +17,7 @@ const taskInfos = {
 	replaceCopyright: {path: "./replaceCopyright.js"},
 	replaceVersion: {path: "./replaceVersion.js"},
 	replaceBuildtime: {path: "./replaceBuildtime.js"},
+	enhanceManifest: {path: "./enhanceManifest.js"},
 	escapeNonAsciiCharacters: {path: "./escapeNonAsciiCharacters.js"},
 	executeJsdocSdkTransformation: {path: "./jsdoc/executeJsdocSdkTransformation.js"},
 	generateApiIndex: {path: "./jsdoc/generateApiIndex.js"},
@@ -98,7 +99,7 @@ export function getRemovedTaskNames() {
 	return ["createDebugFiles", "uglify", "generateManifestBundle"];
 }
 
-// Using CommonsJS require as importing json files causes an ExperimentalWarning
+// Using CommonsJS require since JSON module imports are still experimental
 const require = createRequire(import.meta.url);
 function getVersion(pkg) {
 	return require(`${pkg}/package.json`).version;

package/lib/tasks/transformBootstrapHtml.js

@@ -11,13 +11,12 @@ import bootstrapHtmlTransformer from "../processors/bootstrapHtmlTransformer.js"
  * @param {@ui5/fs/DuplexCollection} parameters.workspace DuplexCollection to read and write files
  * @param {object} parameters.options Options
  * @param {string} parameters.options.projectName Project name
- * @param {string} [parameters.options.namespace] Project namespace
+ * @param {string} [parameters.options.projectNamespace] Project namespace
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
 export default async function({workspace, options}) {
 	const {projectName} = options;
-	// Backward compatibility: "namespace" option got renamed to "projectNamespace"
-	const namespace = options.projectNamespace || options.namespace;
+	const namespace = options.projectNamespace;
 
 	let indexPath;
 	if (namespace) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ui5/builder",
-	"version": "3.5.1",
+	"version": "4.0.1",
 	"description": "UI5 Tooling - Builder",
 	"author": {
 		"name": "SAP SE",
@@ -26,10 +26,10 @@
 		"./tasks/bundlers/utils/*": null,
 		"./package.json": "./package.json",
 		"./internal/taskRepository": "./lib/tasks/taskRepository.js",
-		"./internal/jsdoc/template/publish": "./lib/processors/jsdoc/lib/ui5/template/publish.cjs"
+		"./internal/jsdoc/template/publish": "./lib/processors/jsdoc/lib/ui5/template/publish.js"
 	},
 	"engines": {
-		"node": "^16.18.0 || >=18.12.0",
+		"node": "^20.11.0 || >=22.0.0",
 		"npm": ">= 8"
 	},
 	"scripts": {
@@ -47,7 +47,7 @@
 		"jsdoc-generate": "jsdoc -c ./jsdoc.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ./lib/ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
 		"jsdoc-watch": "npm run jsdoc && chokidar \"./lib/**/*.js\" -c \"npm run jsdoc-generate\"",
 		"preversion": "npm test",
-		"version": "git-chglog --sort semver --next-tag v$npm_package_version -o CHANGELOG.md v3.0.0.. && git add CHANGELOG.md",
+		"version": "git-chglog --sort semver --next-tag v$npm_package_version -o CHANGELOG.md v4.0.0.. && git add CHANGELOG.md",
 		"prepublishOnly": "git push --follow-tags",
 		"release-note": "git-chglog --sort semver -c .chglog/release-config.yml v$npm_package_version",
 		"depcheck": "depcheck --ignores @ui5/builder,docdash,@istanbuljs/esm-loader-hook,catharsis --parsers='**/*.js:es6,**/*.cjs:es6'"
@@ -64,9 +64,11 @@
 		"files": [
 			"test/lib/**/*.js"
 		],
-		"ignoredByWatcher": [
-			"test/tmp/**"
-		],
+		"watchMode": {
+			"ignoreChanges": [
+				"test/tmp/**"
+			]
+		},
 		"nodeArguments": [
 			"--loader=esmock",
 			"--no-warnings"
@@ -120,29 +122,27 @@
 	},
 	"dependencies": {
 		"@jridgewell/sourcemap-codec": "^1.5.0",
-		"@ui5/fs": "^3.0.5",
-		"@ui5/logger": "^3.0.0",
+		"@ui5/fs": "^4.0.0",
+		"@ui5/logger": "^4.0.1",
 		"cheerio": "1.0.0-rc.12",
 		"escape-unicode": "^0.2.0",
 		"escope": "^4.0.0",
-		"espree": "^9.6.1",
+		"espree": "^10.1.0",
 		"graceful-fs": "^4.2.11",
 		"jsdoc": "^4.0.3",
 		"less-openui5": "^0.11.6",
 		"pretty-data": "^0.40.0",
-		"rimraf": "^5.0.9",
+		"rimraf": "^6.0.1",
 		"semver": "^7.6.3",
 		"terser": "^5.31.3",
-		"workerpool": "^6.5.1",
+		"workerpool": "^9.1.3",
 		"xml2js": "^0.6.2"
 	},
 	"devDependencies": {
 		"@istanbuljs/esm-loader-hook": "^0.2.0",
 		"@jridgewell/trace-mapping": "^0.3.25",
-		"@ui5/project": "^3.9.2",
-		"ava": "^5.3.1",
-		"chai": "^4.4.1",
-		"chai-fs": "^2.0.0",
+		"@ui5/project": "^4.0.0",
+		"ava": "^6.1.3",
 		"chokidar-cli": "^3.0.0",
 		"cross-env": "^7.0.3",
 		"depcheck": "^1.4.7",
@@ -150,13 +150,12 @@
 		"eslint": "^8.57.0",
 		"eslint-config-google": "^0.14.0",
 		"eslint-plugin-ava": "^14.0.0",
-		"eslint-plugin-jsdoc": "^46.10.1",
+		"eslint-plugin-jsdoc": "^48.8.3",
 		"esmock": "^2.6.7",
 		"line-column": "^1.0.2",
-		"nyc": "^15.1.0",
-		"open-cli": "^7.2.0",
-		"recursive-readdir": "^2.2.3",
-		"sinon": "^16.1.3",
+		"nyc": "^17.0.0",
+		"open-cli": "^8.0.0",
+		"sinon": "^18.0.0",
 		"tap-xunit": "^2.4.1"
 	}
 }