@ui5/webcomponents-tools 1.10.4-rc.0 → 1.10.5

package/CHANGELOG.md

@@ -3,7 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [1.10.4-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.10.3...v1.10.4-rc.0) (2023-01-26)
+## [1.10.5](https://github.com/SAP/ui5-webcomponents/compare/v1.10.4...v1.10.5) (2023-02-24)
+
+**Note:** Version bump only for package @ui5/webcomponents-tools
+
+
+
+
+
+## [1.10.4](https://github.com/SAP/ui5-webcomponents/compare/v1.10.3...v1.10.4) (2023-02-15)
 
 **Note:** Version bump only for package @ui5/webcomponents-tools
 

package/components-package/nps.js

@@ -120,9 +120,8 @@ const getScripts = (options) => {
 			bundle: `node ${LIB}/dev-server/dev-server.js ${viteConfig}`,
 		},
 		generateAPI: {
-			default: "nps generateAPI.prepare generateAPI.preprocess generateAPI.jsdoc generateAPI.cleanup generateAPI.prepareManifest",
+			default: "nps generateAPI.prepare generateAPI.preprocess generateAPI.jsdoc generateAPI.cleanup",
 			prepare: `node "${LIB}/copy-and-watch/index.js" --silent "dist/**/*.js" jsdoc-dist/`,
-			prepareManifest: `node "${LIB}/generate-custom-elements-manifest/index.js" dist dist`,
 			preprocess: `node "${preprocessJSDocScript}" jsdoc-dist/ src`,
 			jsdoc: `jsdoc -c "${LIB}/jsdoc/configTypescript.json"`,
 			cleanup: "rimraf jsdoc-dist/"

package/lib/generate-custom-elements-manifest/index.js

@@ -1,12 +1,9 @@
 const fs = require("fs").promises;
-const path = require("path");
 // https://github.com/webcomponents/custom-elements-manifest/blob/main/schema.json
 
-const inputDir = process.argv[2];
-const outputDir = process.argv[3];
-
 const camelToKebabMap = new Map();
 const apiIndex = new Map();
+const processedApiIndex = new Set();
 const forbiddenAttributeTypes = ["object", "array"];
 
 const camelToKebabCase = string => {
@@ -19,7 +16,7 @@ const camelToKebabCase = string => {
 
 const generateJavaScriptExport = entity => {
 	return {
-		declaration: generateRefenrece(entity.name),
+		declaration: generateRefenrece(entity),
 		deprecated: !!entity.deprecated,
 		kind: "js",
 		name: "default",
@@ -229,6 +226,8 @@ const generateSlots = slots => {
 };
 
 const generateCustomElementDeclaration = entity => {
+	entity = generateFullComponentApi(entity);
+
 	let generatedCustomElementDeclaration = {
 		deprecated: !!entity.deprecated,
 		customElement: true,
@@ -266,60 +265,107 @@ const generateCustomElementDeclaration = entity => {
 	}
 
 	if (entity.extends && entity.extends !== "HTMLElement") {
-		generatedCustomElementDeclaration.superclass = generateRefenrece(entity.extends);
+		generatedCustomElementDeclaration.superclass = generateRefenrece(apiIndex.get(entity.extends));
 	}
 
 	return generatedCustomElementDeclaration;
 };
 
-const generateRefenrece = (entityName) => {
+const generateRefenrece = (entity) => {
 	let packageName;
-	let basename;
 
-	if (!entityName) {
+	if (!entity.name) {
 		throw new Error("JSDoc error: entity not found in api.json.");
 	}
 
-	if (entityName.includes(".")) {
-		basename = entityName.split(".").pop();
-	} else {
-		basename = entityName
-	}
-
-	if (entityName.includes("sap.ui.webc.main")) {
+	if (entity.name.includes("sap.ui.webc.main")) {
 		packageName = "@ui5/webcomponents";
-	} else if (entityName.includes("sap.ui.webc.fiori")) {
+	} else if (entity.name.includes("sap.ui.webc.fiori")) {
 		packageName = "@ui5/webcomponents-fiori";
-	} else if (entityName.includes("sap.ui.webc.base")) {
+	} else if (entity.name.includes("sap.ui.webc.base")) {
 		packageName = "@ui5/webcomponents-base";
 	}
 
 	return {
-		module: `${basename}.js`,
-		name: `${basename}`,
+		module: `${entity.module}.js`,
+		name: `${entity.basename}`,
 		package: packageName,
 	};
 };
 
+const generateFullComponentApi = entity => {
+	const componentProps = ["properties", "slots", "events", "methods"];
+	let parent = apiIndex.get(entity.extends);
+
+	if (!parent) {
+		processedApiIndex.add(entity.name);
+
+		return entity;
+	}
+
+	parent = processedApiIndex.has(entity.extends) ? apiIndex.get(entity.extends) : generateFullComponentApi(parent);
+
+	componentProps.forEach(prop => {
+		if (parent[prop] && parent[prop].length) {
+			if (entity[prop] && entity[prop].length) {
+				const uniqueParentState = parent[prop].filter(pSlot => {
+					return !entity[prop].some(eSlot => eSlot.name === pSlot.name);
+				});
+
+				entity[prop] = entity[prop].concat(uniqueParentState);
+			} else {
+				entity[prop] = [...parent[prop]];
+			}
+		}
+	});
+
+	processedApiIndex.add(entity.name);
+
+	return entity;
+};
+
 const filterPublicApi = array => {
 	return (array || []).filter(el => el.visibility === "public");
 };
 
 const generate = async () => {
-	const file = JSON.parse(await fs.readFile(path.join(inputDir, "api.json")));
-	let customElementsManifest = {
-		schemaVersion: "1.0.0",
-		readme: "",
-		modules: [],
-	};
+	const apiFilesPaths = [
+		require.resolve("@ui5/webcomponents-base/dist/api.json"),
+		require.resolve("@ui5/webcomponents/dist/api.json"),
+		require.resolve("@ui5/webcomponents-fiori/dist/api.json"),
+	];
+
+	let apiFiles = new Map();
+
+	await Promise.all(apiFilesPaths.map(async (apiFilePath) => {
+		const file = JSON.parse(await fs.readFile(apiFilePath));
 
-	file.symbols.forEach(entity => {
-		if (entity.tagname) {
-			customElementsManifest.modules.push(generateJavaScriptModule(entity));
+		apiFiles.set(apiFilePath, file);
+
+		file.symbols.forEach(symbol => {
+			apiIndex.set(symbol.name, symbol);
+		});
+	}));
+
+	await Promise.all(apiFilesPaths.map(async (apiFilePath) => {
+		if (apiFilePath.includes("base")) {
+			return;
 		}
-	});
 
-	await fs.writeFile(path.join(outputDir, "custom-elements.json"), JSON.stringify(customElementsManifest));
+		let customElementsManifest = {
+			schemaVersion: "1.0.0",
+			readme: "",
+			modules: [],
+		};
+
+		apiFiles.get(apiFilePath).symbols.forEach(entity => {
+			if (entity.tagname) {
+				customElementsManifest.modules.push(generateJavaScriptModule(entity));
+			}
+		});
+
+		await fs.writeFile(apiFilePath.replace("api.json", "custom-elements.json"), JSON.stringify(customElementsManifest));
+	}));
 };
 
 generate().then(() => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ui5/webcomponents-tools",
-  "version": "1.10.4-rc.0",
+  "version": "1.10.5",
   "description": "UI5 Web Components: webcomponents.tools",
   "author": "SAP SE (https://www.sap.com)",
   "license": "Apache-2.0",
@@ -72,5 +72,5 @@
   "devDependencies": {
     "yargs": "^17.5.1"
   },
-  "gitHead": "b618aed1a969ce5a738b620cb8b2d7d796638d4c"
+  "gitHead": "80761cf0065e72e98596c20c4136e4113d96386a"
 }