@ui5/builder 2.11.5 → 3.0.0-alpha.10

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

@@ -1,7 +1,7 @@
 /*
  * JSDoc3 plugin for UI5 documentation generation.
  *
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -288,10 +288,11 @@ function collectShortcuts(body) {
 		} else if ( valueNode.type === Syntax.MemberExpression ) {
 			const _import = getLeftmostName(valueNode);
 			const local = _import && currentModule.localNames[_import];
-			if ( typeof local === 'object' && local.module ) {
+			const objectName = getObjectName(valueNode);
+			if ( objectName && typeof local === 'object' && local.module ) {
 				currentModule.localNames[name] = {
 					module: local.module,
-					path: getObjectName(valueNode).split('.').slice(1).join('.') // TODO chaining if local has path
+					path: objectName.split('.').slice(1).join('.') // TODO chaining if local has path
 				};
 				debug(`  found local shortcut: ${name} ${currentModule.localNames[name]}`);
 			}
@@ -1617,7 +1618,7 @@ function createAutoDoc(oClassInfo, classComment, doclet, node, parser, filename,
 				"Removes a " + n1 + " from the aggregation " + link + ".",
 				"",
 				"@param {int | string | " + makeTypeString(info, true) + "} " + varname(n1, "variant") + " The " + n1 + " to remove or its index or id",
-				"@returns {" + makeTypeString(info, true) + "} The removed " + n1 + " or <code>null</code>",
+				"@returns {" + makeTypeString(info, true) + "|null} The removed " + n1 + " or <code>null</code>",
 				info.since ? "@since " + info.since : "",
 				info.deprecation ? "@deprecated " + info.deprecation : "",
 				info.experimental ? "@experimental " + info.experimental : "",
@@ -1812,7 +1813,7 @@ function createAutoDoc(oClassInfo, classComment, doclet, node, parser, filename,
 			"",
 			"@param {object}",
 			"           [oData] An application-specific payload object that will be passed to the event handler along with the event object when firing the event",
-			"@param {function}",
+			"@param {function(sap.ui.base.Event):void}",
 			"           fnFunction The function to be called when the event occurs",
 			"@param {object}",
 			"           [oListener] Context object to call the event handler with. Defaults to this <code>" + oClassInfo.name + "</code> itself",
@@ -1830,7 +1831,7 @@ function createAutoDoc(oClassInfo, classComment, doclet, node, parser, filename,
 			"",
 			"The passed function and listener object must match the ones used for event registration.",
 			"",
-			"@param {function}",
+			"@param {function(sap.ui.base.Event):void}",
 			"           fnFunction The function to be called, when the event occurs",
 			"@param {object}",
 			"           [oListener] Context object on which the given function had to be called",
@@ -2677,3 +2678,107 @@ exports.astNodeVisitor = {
 	}
 
 };
+
+(function() {
+	const jsdocType = require("jsdoc/lib/jsdoc/tag/type");
+	const catharsis = require('catharsis');
+	const TYPES = catharsis.Types;
+
+	const toTypeString = (type) => getTypeStrings(type).join("|");
+
+	/*
+	 * This function has been copied from jsdoc/lib/jsdoc/tag/type (version 3.6.7)
+	 * The copy has been enhanced with the changes from https://github.com/jsdoc/jsdoc/pull/1735
+	 * to retain the full function signature for function types.
+	 *
+	 * JSDoc is copyright (c) 2011-present Michael Mathews micmath@gmail.com and the contributors to JSDoc.
+	 */ 
+	function getTypeStrings(parsedType, isOutermostType) {
+		let applications;
+		let typeString;
+		let types = [];
+		switch (parsedType.type) {
+			case TYPES.AllLiteral:
+				types.push('*');
+				break;
+			case TYPES.FunctionType:
+				typeString = 'function';
+				// #### BEGIN: MODIFIED BY SAP
+				const paramTypes = [];
+				if (parsedType.new) {
+					paramTypes.push(toTypeString(parsedType.new));
+				}
+				if (Array.isArray(parsedType.params)) {
+					paramTypes.push(...parsedType.params.map(toTypeString));
+				}
+				if (paramTypes.length || parsedType.result) {
+					typeString += `(${paramTypes.join(", ")})`;
+				}
+				if (parsedType.result) {
+					typeString += `:${toTypeString(parsedType.result)}`;
+				}
+				types.push(typeString);
+				// #### END: MODIFIED BY SAP
+				break;
+			 case TYPES.NameExpression:
+				 types.push(parsedType.name);
+				break;
+			case TYPES.NullLiteral:
+				types.push('null');
+				break;
+			case TYPES.RecordType:
+				// #### BEGIN: MODIFIED BY SAP
+				// types.push('Object');
+				if (Array.isArray(parsedType.fields)) {
+					typeString = `{${parsedType.fields.map(
+						({key,value}) => `${catharsis.stringify(key)}: ${toTypeString(value)}`
+					).join(', ')}}`;
+					types.push(typeString);
+				} else {
+					types.push('Object');
+				}
+				// #### END: MODIFIED BY SAP
+				break;
+			case TYPES.TypeApplication:
+				// if this is the outermost type, we strip the modifiers; otherwise, we keep them
+				if (isOutermostType) {
+					applications = parsedType.applications.map(application =>
+						catharsis.stringify(application)).join(', ');
+					typeString = `${getTypeStrings(parsedType.expression)[0]}.<${applications}>`;
+					types.push(typeString);
+				}
+				else {
+					types.push( catharsis.stringify(parsedType) );
+				}
+				break;
+			case TYPES.TypeUnion:
+				parsedType.elements.forEach(element => {
+					types = types.concat( getTypeStrings(element) );
+				});
+				break;
+			case TYPES.UndefinedLiteral:
+				types.push('undefined');
+				break;
+			case TYPES.UnknownLiteral:
+				types.push('?');
+				break;
+			default:
+				// this shouldn't happen
+				throw new Error(`unrecognized type ${parsedType.type} in parsed type: ${parsedType}`);
+		}
+		return types;
+	}
+
+	const origParse = jsdocType.parse;
+	jsdocType.parse = function() {
+		const tagInfo = origParse.apply(this, arguments);
+		if ( tagInfo && /function/.test(tagInfo.typeExpression) && tagInfo.parsedType ) {
+			// console.info("old typeExpression", tagInfo.typeExpression); 
+			// console.info("old parse tree", tagInfo.parsedType); 
+			// console.info("old parse result", tagInfo.type); 
+			tagInfo.type = getTypeStrings(tagInfo.parsedType);
+			// console.info("new parse result", tagInfo.type); 
+		}
+		return tagInfo;
+	}
+}());

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

@@ -1,7 +1,7 @@
 /*
  * JSDoc3 template for UI5 documentation generation.
  *
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -1660,59 +1660,59 @@ function makeLinkList(aSymbols) {
 class ASTBuilder {
 	literal(str) {
 		return {
-			type: 'literal',
+			type: "literal",
 			value: str
 		};
 	}
 	simpleType(type) {
 		return {
-			type: 'simpleType',
+			type: "simpleType",
 			name: type
 		};
 	}
 	array(componentType) {
 		return {
-			type: 'array',
+			type: "array",
 			component: componentType
 		};
 	}
 	object(keyType, valueType) {
 		return {
-			type: 'object',
+			type: "object",
 			key: keyType,
 			value: valueType
 		};
 	}
 	set(elementType) {
 		return {
-			type: 'set',
+			type: "set",
 			element: elementType
 		};
 	}
 	promise(fulfillmentType) {
 		return {
-			type: 'promise',
+			type: "promise",
 			fulfill: fulfillmentType
 		};
 	}
 	"function"(paramTypes, returnType, thisType, constructorType) {
 		return {
-			type: 'function',
-			params: paramTypes,
+			"type": "function",
+			"params": paramTypes,
 			"return": returnType,
 			"this": thisType,
-			constructor: constructorType
+			"constructor": constructorType
 		};
 	}
 	structure(structure) {
 		return {
-			type: 'structure',
+			type: "structure",
 			fields: structure
 		};
 	}
 	union(types) {
 		return {
-			type: 'union',
+			type: "union",
 			types: types
 		};
 	}
@@ -1737,7 +1737,7 @@ class ASTBuilder {
 	}
 	typeApplication(type, templateTypes) {
 		return {
-			type: 'typeApplication',
+			type: "typeApplication",
 			baseType: type,
 			templateTypes: templateTypes
 		};
@@ -1855,28 +1855,26 @@ class TypeStringBuilder {
 }
 
 function TypeParser(defaultBuilder = new ASTBuilder()) {
+	const rLexer = /\s*(Array\.?<|Object\.?<|Set\.?<|Promise\.?<|function\(|\{|:|\(|\||\}|\.?<|>|\)|,|\[\]|\*|\?|!|=|\.\.\.)|\s*(false|true|(?:\+|-)?(?:\d+(?:\.\d+)?|NaN|Infinity)|'[^']*'|"[^"]*"|null|undefined)|\s*((?:module:)?\w+(?:[/.#~]\w+)*)|./g;
 
-	/* TODO
-	 * - function(this:) // type of this
-	 * - function(new:) // constructor
-	 */
-	const rLexer = /\s*(Array\.?<|Object\.?<|Set\.?<|Promise\.?<|function\(|\{|:|\(|\||\}|\.?<|>|\)|,|\[\]|\*|\?|!|=|\.\.\.)|\s*(false|true|(?:\+|-)?(?:\d+(?:\.\d+)?|NaN|Infinity)|'[^']*'|"[^"]*"|null|undefined)|\s*((?:module:)?\w+(?:[\/.#~]\w+)*)|./g;
-
-	let input,
-		builder,
-		token,
-		tokenStr;
+	let input;
+	let builder;
+	let token;
+	let tokenStr;
 
 	function next(expected) {
 		if ( expected !== undefined && token !== expected ) {
-			throw new SyntaxError(`TypeParser: expected '${expected}', but found '${tokenStr}' (pos: ${rLexer.lastIndex}, input='${input}')`);
+			throw new SyntaxError(
+				`TypeParser: expected '${expected}', but found '${tokenStr}' ` +
+				`(pos: ${rLexer.lastIndex}, input='${input}')`
+			);
 		}
 		const match = rLexer.exec(input);
 		if ( match ) {
 			tokenStr = match[1] || match[2] || match[3];
-			token = match[1] || (match[2] && 'literal') || (match[3] && 'symbol');
+			token = match[1] || (match[2] && "literal") || (match[3] && "symbol");
 			if ( !token ) {
-				throw new SyntaxError(`TypeParser: unexpected '${tokenStr}' (pos: ${match.index}, input='${input}')`);
+				throw new SyntaxError(`TypeParser: unexpected '${match[0]}' (pos: ${match.index}, input='${input}')`);
 			}
 		} else {
 			tokenStr = token = null;
@@ -1886,147 +1884,166 @@ function TypeParser(defaultBuilder = new ASTBuilder()) {
 	function parseType() {
 		let nullable = false;
 		let mandatory = false;
-		if ( token === '?' ) {
+		if ( token === "?" ) {
 			next();
 			nullable = true;
-		} else if ( token === '!' ) {
+		} else if ( token === "!" ) {
 			next();
 			mandatory = true;
 		}
 
 		let type;
 
-		if ( token === 'literal' ) {
+		if ( token === "literal" ) {
 			type = builder.literal(tokenStr);
 			next();
-		} else if ( token === 'Array.<' || token === 'Array<' ) {
+		} else if ( token === "Array.<" || token === "Array<" ) {
 			next();
-			const componentType = parseType();
-			next('>');
+			const componentType = parseTypes();
+			next(">");
 			type = builder.array(componentType);
-		} else if ( token === 'Object.<' || token === 'Object<' ) {
+		} else if ( token === "Object.<" || token === "Object<" ) {
 			next();
 			let keyType;
-			let valueType = parseType();
-			if ( token === ',' ) {
+			let valueType = parseTypes();
+			if ( token === "," ) {
 				next();
 				keyType = valueType;
-				valueType = parseType();
+				valueType = parseTypes();
 			} else {
-				keyType = builder.synthetic(builder.simpleType('string'));
+				keyType = builder.synthetic(builder.simpleType("string"));
 			}
-			next('>');
+			next(">");
 			type = builder.object(keyType, valueType);
-		} else if ( token === 'Set.<' || token === 'Set<' ) {
+		} else if ( token === "Set.<" || token === "Set<" ) {
 			next();
-			const elementType = parseType();
-			next('>');
+			const elementType = parseTypes();
+			next(">");
 			type = builder.set(elementType);
-		} else if ( token === 'Promise.<' || token === 'Promise<' ) {
+		} else if ( token === "Promise.<" || token === "Promise<" ) {
 			next();
-			const resultType = parseType();
-			next('>');
+			const resultType = parseTypes();
+			next(">");
 			type = builder.promise(resultType);
-		} else if ( token === 'function(' ) {
+		} else if ( token === "function(" ) {
 			next();
-			let thisType, constructorType, paramTypes = [], returnType;
-			if ( tokenStr === 'this' ) {
+			let thisType;
+			let constructorType;
+			const paramTypes = [];
+			let returnType;
+			if ( tokenStr === "this" ) {
 				next();
-				next(':');
+				next(":");
 				thisType = parseType();
-				if ( token === ',' ) {
-					next();
+				if ( token !== ")" ) {
+					next(",");
 				}
-			} else if ( tokenStr === 'new' ) {
+			} else if ( tokenStr === "new" ) {
 				next();
-				next(':');
+				next(":");
 				constructorType = parseType();
-				if ( token === ',' ) {
-					next();
+				if ( token !== ")" ) {
+					next(",");
 				}
 			}
-			while ( token === 'symbol' || token === '...' ) {
-				const repeatable = token === '...';
-				if ( repeatable) {
+			while ( token !== ")" ) {
+				const repeatable = token === "...";
+				if ( repeatable ) {
 					next();
 				}
-				let paramType = parseType();
+				let paramType = parseTypes();
 				if ( repeatable ) {
 					paramType = builder.repeatable(paramType);
 				}
-				const optional = token === '=';
+				const optional = token === "=";
 				if ( optional ) {
 					builder.optional(paramType);
 					next();
 				}
 				paramTypes.push(paramType);
-				if ( token === ',' ) {
-					if ( repeatable ) {
-						throw new SyntaxError(`TypeParser: only the last parameter of a function can be repeatable (pos: ${rLexer.lastIndex}, input='${input}')`);
-					}
-					next();
+
+				// exit if there are no more parameters
+				if ( token !== "," ) {
+					break;
 				}
+
+				if ( repeatable ) {
+					throw new SyntaxError(
+						`TypeParser: only the last parameter of a function can be repeatable ` +
+						`(pos: ${rLexer.lastIndex}, input='${input}')`
+					);
+				}
+
+				// consume the comma
+				next();
 			}
-			next(')');
-			if ( token === ':' ) {
-				next(':');
+			next(")");
+			if ( token === ":" ) {
+				next(":");
 				returnType = parseType();
 			}
 			type = builder.function(paramTypes, returnType, thisType, constructorType);
-		} else if ( token === '{' ) {
+		} else if ( token === "{" ) {
 			const structure = Object.create(null);
 			next();
 			do {
 				const propName = tokenStr;
 				if ( !/^\w+$/.test(propName) ) {
-					throw new SyntaxError(`TypeParser: structure field must have a simple name (pos: ${rLexer.lastIndex}, input='${input}', field:'${propName}')`);
+					throw new SyntaxError(
+						`TypeParser: structure field must have a simple name ` +
+						`(pos: ${rLexer.lastIndex}, input='${input}', field:'${propName}')`
+					);
 				}
-				next('symbol');
+				next("symbol");
 				let propType;
-				if ( token === ':' ) {
+				if ( token === ":" ) {
 					next();
-					propType = parseType();
+					propType = parseTypes();
 				} else {
-					propType = builder.synthetic(builder.simpleType('any'));
+					propType = builder.synthetic(builder.simpleType("any"));
 				}
 				structure[propName] = propType;
-				if ( token === '}' ) {
+				if ( token === "}" ) {
 					break;
 				}
-				next(',');
+				next(",");
 			} while (token);
-			next('}');
+			next("}");
 			type = builder.structure(structure);
-		} else if ( token === '(' ) {
+		} else if ( token === "(" ) {
 			next();
 			type = parseTypes();
-			next(')');
-		} else if ( token === '*' ) {
+			next(")");
+		} else if ( token === "*" ) {
 			next();
-			type = builder.simpleType('*');
+			type = builder.simpleType("*");
 		} else {
 			type = builder.simpleType(tokenStr);
-			next('symbol');
+			next("symbol");
 			// check for suffix operators: either 'type application' (generics) or 'array', but not both of them
 			if ( token === "<" || token === ".<" ) {
 				next();
 				const templateTypes = [];
-				while ( token !== ">" ) {
-					const templateType = parseType();
+				do {
+					const templateType = parseTypes();
 					templateTypes.push(templateType);
-					if ( token === ',' ) {
-						next();
+					if ( token === ">" ) {
+						break;
 					}
-				}
+					next(",");
+				} while (token);
 				next(">");
 				type = builder.typeApplication(type, templateTypes);
 			} else {
-				while ( token === '[]' ) {
+				while ( token === "[]" ) {
 					next();
 					type = builder.array(type);
 				}
 			}
 		}
+		if ( builder.normalizeType ) {
+			type = builder.normalizeType(type);
+		}
 		if ( nullable ) {
 			type = builder.nullable(type);
 		}
@@ -2040,7 +2057,7 @@ function TypeParser(defaultBuilder = new ASTBuilder()) {
 		const types = [];
 		do {
 			types.push(parseType());
-			if ( token !== '|' ) {
+			if ( token !== "|" ) {
 				break;
 			}
 			next();
@@ -2065,7 +2082,6 @@ function TypeParser(defaultBuilder = new ASTBuilder()) {
 		next(null);
 		return type;
 	};
-
 }
 
 class TypeLinkBuilder extends TypeStringBuilder {
@@ -3428,17 +3444,22 @@ const builtinTypes = {
 	WeakMap: true,
 
 	// Web APIs
+	Attr:true,
 	Blob:true,
+	DataTransfer:true,
 	Document:true,
 	Element:true,
 	Event:true,
 	File:true,
-	HTMLElement: true,
+	FileList:true,
+	HTMLDocument:true,
+	HTMLElement:true,
 	Node:true,
 	Storage:true,
 	Touch:true,
 	TouchList:true,
-	Window: true
+	Window:true,
+	XMLDocument:true
 
 };
 

package/lib/processors/jsdoc/lib/ui5/template/utils/versionUtil.js

@@ -1,6 +1,6 @@
 
 
-const rSinceVersion = /^([0-9]+(?:\.[0-9]+(?:\.[0-9]+)?)?([-.][0-9A-Z]+)?)(\.$|\.\s+|[,:]\s*|\s-\s*|\s|$)/i;
+const rSinceVersion = /^([0-9]+(?:\.[0-9]+(?:\.[0-9]+)?)?([-.][0-9A-Z]+)?)(\.$|\.\s+|[,:;]\s*|\s-\s*|\s|$)/i;
 function _parseVersion(value) {
 	const m = rSinceVersion.exec(value);
 	if (m) {

package/lib/processors/manifestCreator.js

@@ -157,7 +157,9 @@ class LibraryBundle {
 /*
  * Creates the library manifest.json file for a UILibrary.
  */
-async function createManifest(libraryResource, libBundle, descriptorVersion, _include3rdParty, omitMinVersions) {
+async function createManifest(
+	libraryResource, libBundle, descriptorVersion, _include3rdParty, omitMinVersions, getProjectVersion
+) {
 	// create a Library wrapper around the .library XML
 	const library = await Library.from(libraryResource);
 
@@ -223,13 +225,6 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 			return version && version !== "@version@" && version !== "${version}";
 		}
 
-		function getProjectVersion() {
-			const project = libraryResource._project;
-			if ( project ) {
-				return project.version;
-			}
-		}
-
 		function getLibraryTitle() {
 			if ( library.getTitle() ) {
 				return library.getTitle();
@@ -321,7 +316,7 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 			embeds: findEmbeddedComponents(),
 			i18n,
 			applicationVersion: {
-				version: isValid(library.getVersion()) ? library.getVersion() : getProjectVersion()
+				version: isValid(library.getVersion()) ? library.getVersion() : getProjectVersion(library.getName())
 			},
 			title: getLibraryTitle(),
 			description: library.getDocumentation(),
@@ -393,12 +388,7 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 
 	function createSapUI5() {
 		function getUI5Version() {
-			const dummy = new Dependency({
-				libraryName: [{
-					_: "sap.ui.core"
-				}]
-			});
-			return normalizeVersion(getVersion(dummy));
+			return normalizeVersion(getProjectVersion("sap.ui.core"));
 		}
 
 		function dependencies() {
@@ -410,7 +400,7 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 			if ( library.getDependencies() != null ) {
 				for (const dep of library.getDependencies()) {
 					dependencies.libs[dep.getLibraryName()] = {
-						minVersion: omitMinVersions ? "" : getVersion(dep),
+						minVersion: omitMinVersions ? "" : getProjectVersion(dep.getLibraryName()),
 						lazy: dep.isLazy() || undefined // suppress default (false)
 					};
 				}
@@ -619,33 +609,6 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 		return v.major + "." + v.minor;
 	}
 
-	function getVersion(dependency) {
-		const version = dependency.getVersion();
-		if ( version != null ) {
-			return version;
-		}
-
-		function hasName(entity) {
-			return entity.metadata && entity.metadata.name === dependency.getLibraryName();
-		}
-
-		const project = libraryResource._project;
-		if ( project ) {
-			if ( Array.isArray(project.dependencies) ) {
-				const lib = project.dependencies.find(hasName);
-				if ( lib ) {
-					return lib.version;
-				}
-			}
-			if ( hasName(project) ) {
-				return project.version;
-			}
-		}
-
-		throw new Error(
-			`Couldn't find version for library '${dependency.getLibraryName()}', project dependency missing?`);
-	}
-
 	return {
 		"_version": descriptorVersion.toString(),
 		"sap.app": createSapApp(),
@@ -657,7 +620,7 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 	};
 }
 
-module.exports = function({libraryResource, resources, options}) {
+module.exports = function({libraryResource, resources, getProjectVersion, options}) {
 	// merge options with defaults
 	options = Object.assign({
 		descriptorVersion: APP_DESCRIPTOR_V22, // TODO 3.0: change this to type string instead of a semver object
@@ -677,7 +640,7 @@ module.exports = function({libraryResource, resources, options}) {
 	}
 
 	return createManifest(libraryResource, libBundle, options.descriptorVersion, options.include3rdParty,
-		options.omitMinVersions)
+		options.omitMinVersions, getProjectVersion)
 		.then((manifest) => {
 			return new EvoResource({
 				path: resourcePathPrefix + "manifest.json",