@ui5/builder 3.0.0-alpha.1 → 3.0.0-alpha.11

package/lib/processors/jsdoc/lib/transformApiJson.js

@@ -1,7 +1,7 @@
 /*
  * Node script to preprocess api.json files for use in the UI5 SDKs.
  *
- * (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.
  */
 
@@ -25,6 +25,11 @@ const log = (function() {
 	}
 }());
 
+function replaceLastPathSegment(p, replacement) {
+	// Note: path.join also correctly normalizes any POSIX paths on Windows
+	return path.join(path.dirname(p), replacement);
+}
+
 /*
  * Transforms the api.json as created by the JSDoc build into a pre-processed api.json file suitable for the SDK.
  *
@@ -698,7 +703,7 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 							oMethod.returnValue.types.forEach(oType => {
 
 								// Link Enabled
-								if (!isBuiltInType(oType.value)) {
+								if (!isBuiltInType(oType.value) && possibleUI5Symbol(oType.value)) {
 									oType.href = "api/" + oType.value.replace("[]", "");
 									oType.linkEnabled = true;
 								}
@@ -981,6 +986,57 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 			// Normalize path to resolve relative path
 			sPath = path.normalize(sPath);
 
+			const {sources} = options;
+			let {librarySrcDir, libraryTestDir} = options;
+
+			// Using path.join to normalize POSIX paths to Windows paths on Windows
+			librarySrcDir = path.join(librarySrcDir);
+			libraryTestDir = path.join(libraryTestDir);
+
+			if (Array.isArray(sources) && typeof librarySrcDir === "string" && typeof libraryTestDir === "string") {
+				/**
+				 * Calculate prefix to check
+				 *
+				 * Example 1:
+				 * - sSource: /path/to/project/src
+				 * - sLibrarySrcDir: src
+				 *
+				 * Prefix: /path/to/project/test-resources
+				 *
+				 * Example 2:
+				 * - sSource: /path/to/project/src/main/js
+				 * - sLibrarySrcDir: src/main/js
+				 *
+				 * Prefix: /path/to/project/src/main/test-resources
+				 */
+				const librarySrcDirWithTestResources = replaceLastPathSegment(librarySrcDir, "test-resources");
+
+				for (const sourcePath of sources) {
+					/**
+					 * Replace prefix with file system path
+					 *
+					 * Example 1:
+					 * - sPath: /path/to/project/test-resources/sap/test/demokit/docuindex.json
+					 *
+					 * New sPath: /path/to/project/test/sap/test/demokit/docuindex.json
+					 *
+					 * Example 2:
+					 * - sPath: /path/to/project/src/main/test-resources/sap/test/demokit/docuindex.json
+					 *
+					 * New sPath: /path/to/project/src/main/test/sap/test/demokit/docuindex.json
+					 */
+					if (!sourcePath.endsWith(librarySrcDir)) {
+						continue;
+					}
+					const libraryDir = sourcePath.substring(0, sourcePath.lastIndexOf(librarySrcDir) - 1);
+					const prefix = path.join(libraryDir, librarySrcDirWithTestResources);
+					if (sPath.startsWith(prefix)) {
+						sPath = path.join(libraryDir, libraryTestDir, sPath.substring(prefix.length));
+						break;
+					}
+				}
+			}
+
 			fs.readFile(sPath, 'utf8', (oError, oFileData) => {
 				if (!oError) {
 					oFileData = JSON.parse(oFileData);
@@ -991,7 +1047,7 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 						});
 					}
 				}
-				// We aways resolve as this data is not mandatory
+				// We always resolve as this data is not mandatory
 				oResolve(oChainObject);
 			});
 
@@ -1154,7 +1210,7 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 		},
 
 		formatMethodCode: function (sName, aParams, aReturnValue) {
-			var result = '<pre class="prettyprint">' + sName + '(';
+			var result = '<pre>' + sName + '(';
 
 			if (aParams && aParams.length > 0) {
 				/* We consider only root level parameters so we get rid of all that are not on the root level */
@@ -1258,7 +1314,7 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 		 * @returns string - The code needed to create an object of that class
 		 */
 		formatConstructor: function (name, params) {
-			var result = '<pre class="prettyprint">new ';
+			var result = '<pre>new ';
 
 			if (name) {
 				result += name + '(';
@@ -1386,13 +1442,16 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 
 		},
 
+		formatUrlToLink: function(sTarget, sText, bSAPHosted){
+			return `<a target="_blank" rel="noopener noreferrer" href="${sTarget}">${sText}</a>
+			<img src="./resources/sap/ui/documentation/sdk/images/${bSAPHosted ? 'link-sap' : 'link-external'}.png"
+			title="Information published on ${bSAPHosted ? '' : 'non '}SAP site" class="sapUISDKExternalLink"/>`;
+		},
+
 		handleExternalUrl: function (sTarget, sText) {
 			// Check if the external domain is SAP hosted
 			let bSAPHosted = /^https?:\/\/([\w.]*\.)?(?:sap|hana\.ondemand|sapfioritrial)\.com/.test(sTarget);
-
-			return `<a target="_blank" rel="noopener noreferrer" href="${sTarget}">${sText}</a>
-<img src="./resources/sap/ui/documentation/sdk/images/${bSAPHosted ? 'link-sap' : 'link-external'}.png"
-title="Information published on ${bSAPHosted ? '' : 'non '}SAP site" class="sapUISDKExternalLink"/>`;
+			return this.formatUrlToLink(sTarget, sText, bSAPHosted);
 		},
 
 		/**
@@ -1505,8 +1564,7 @@ title="Information published on ${bSAPHosted ? '' : 'non '}SAP site" class="sapU
 						name: oResult.static ? [self.name, oResult.name].join(".") : oResult.name,
 						type: "methods",
 						className: className,
-						text: text,
-						local: true
+						text: text
 					});
 				}
 			}
@@ -1546,7 +1604,7 @@ title="Information published on ${bSAPHosted ? '' : 'non '}SAP site" class="sapU
 		 * @param {string} [hrefAppend=""]
 		 * @returns {string} link
 		 */
-		createLink: function ({name, type, className, text=name, local=false, hrefAppend=""}) {
+		createLink: function ({name, type, className, text=name, hrefAppend=""}) {
 			let sLink;
 
 			// handling module's
@@ -1561,12 +1619,7 @@ title="Information published on ${bSAPHosted ? '' : 'non '}SAP site" class="sapU
 				sLink += hrefAppend;
 			}
 
-			if (local) {
-			  	let sScrollClass = "scrollTo" + type[0].toUpperCase() + type.slice(1, -1);
-				return `<a target="_self" class="jsdoclink ${sScrollClass}" data-target="${name}" href="api/${sLink}">${text}</a>`;
-			}
-
-			return `<a target="_self" class="jsdoclink" href="api/${sLink}">${text}</a>`;
+			return `<a target="_self" href="api/${sLink}">${text}</a>`;
 		},
 
 		/**
@@ -1594,11 +1647,17 @@ title="Information published on ${bSAPHosted ? '' : 'non '}SAP site" class="sapU
 						}
 
 						// topic:xxx Topic
-						aMatch = sTarget.match(/^topic:(\w{32})$/);
+						aMatch = sTarget.match(/^topic:(\w{32}(?:#\w*)?(?:\/\w*)?)$/);
 						if (aMatch) {
 							return '<a target="_self" href="topic/' + aMatch[1] + '">' + sText + '</a>';
 						}
 
+						// demo:xxx Demo, open the demonstration page in a new window
+						aMatch = sTarget.match(/^demo:([a-zA-Z0-9\/.]*)$/);
+						if (aMatch) {
+							return this.formatUrlToLink("test-resources/" + aMatch[1], sText, true);
+						}
+
 						// sap.x.Xxx.prototype.xxx - In case of prototype we have a link to method
 						aMatch = sTarget.match(/([a-zA-Z0-9.$_]+?)\.prototype\.([a-zA-Z0-9.$_]+)$/);
 						if (aMatch) {
@@ -1656,7 +1715,6 @@ title="Information published on ${bSAPHosted ? '' : 'non '}SAP site" class="sapU
 								name: aMatch[1] ? `${oSelf.name}.${aMatch[2]}` : aMatch[2],
 								type: "methods",
 								className: oSelf.name,
-								local: true,
 								text: sText
 							});
 						}
@@ -1668,7 +1726,6 @@ title="Information published on ${bSAPHosted ? '' : 'non '}SAP site" class="sapU
 								name: aMatch[1],
 								type: "annotations",
 								className: oSelf.name,
-								local: true,
 								text: sText
 							});
 						}
@@ -1695,7 +1752,6 @@ title="Information published on ${bSAPHosted ? '' : 'non '}SAP site" class="sapU
 								name: aMatch[1],
 								type: "events",
 								className: oSelf.name,
-								local: true,
 								text: sText
 							});
 						}