@ui5/webcomponents-tools 1.22.0-rc.1 → 1.22.0-rc.3

package/lib/cem/utils.mjs

@@ -1,7 +1,7 @@
 import fs from "fs";
 import path from "path";
 
-let JSDocErrors = [];
+let documentationErrors = new Map();
 
 const getDeprecatedStatus = (jsdocComment) => {
     const deprecatedTag = findTag(jsdocComment, "deprecated");
@@ -18,18 +18,20 @@ const normalizeDescription = (description) => {
 	return typeof description === 'string' ? description.replaceAll(/^-\s+|^(\n)+|(\n)+$/g, ""): description;
 }
 
-const getTypeRefs = (ts, classNodeMember, member) => {
+const getTypeRefs = (ts, node, member) => {
     const extractTypeRefs = (type) => {
         if (type?.kind === ts.SyntaxKind.TypeReference) {
             return type.typeArguments?.length
                 ? type.typeArguments.map((typeRef) => typeRef.typeName?.text)
                 : [type.typeName?.text];
+        } else if (type?.kind === ts.SyntaxKind.ArrayType) {
+            return [type.elementType?.typeName?.text];
         } else if (type?.kind === ts.SyntaxKind.UnionType) {
             return type.types
                 .map((type) => extractTypeRefs(type))
                 .flat(1);
         } else if (type?.kind === ts.SyntaxKind.TemplateLiteralType) {
-            if (member.type) {
+            if (member?.type) {
                 member.type.text = member.type.text.replaceAll?.(/`|\${|}/g, "");
             }
 
@@ -39,7 +41,7 @@ const getTypeRefs = (ts, classNodeMember, member) => {
         }
     };
 
-    let typeRefs = extractTypeRefs(classNodeMember.type);
+    let typeRefs = extractTypeRefs(node.type) || node?.typeArguments?.map(n => extractTypeRefs(n)).flat(2);
 
     if (typeRefs) {
         typeRefs = typeRefs.filter((e) => !!e);
@@ -62,7 +64,7 @@ const getPrivacyStatus = (jsdocComment) => {
     return privacyTag?.tag || "private";
 };
 
-const findPackageName = (ts, sourceFile, typeName, packageJSON) => {
+const findPackageName = (ts, sourceFile, typeName) => {
     const localStatements = [
         ts.SyntaxKind.EnumDeclaration,
         ts.SyntaxKind.InterfaceDeclaration,
@@ -102,7 +104,7 @@ const findPackageName = (ts, sourceFile, typeName, packageJSON) => {
     }
 };
 
-const findImportPath = (ts, sourceFile, typeName, packageJSON, modulePath) => {
+const findImportPath = (ts, sourceFile, typeName, modulePath) => {
     const localStatements = [
         ts.SyntaxKind.EnumDeclaration,
         ts.SyntaxKind.InterfaceDeclaration,
@@ -158,6 +160,8 @@ const normalizeTagType = (type) => {
 	return type?.trim();
 }
 
+const packageJSON = JSON.parse(fs.readFileSync("./package.json"));
+
 const getReference = (ts, type, classNode, modulePath) => {
     let sourceFile = classNode.parent;
 
@@ -165,22 +169,19 @@ const getReference = (ts, type, classNode, modulePath) => {
         sourceFile = sourceFile.parent;
     }
 
-    const packageJSON = JSON.parse(fs.readFileSync("./package.json"));
-
     const typeName =
         typeof type === "string"
             ? normalizeTagType(type)
             : type.class?.expression?.text ||
             type.typeExpression?.type?.getText() ||
             type.typeExpression?.type?.elementType?.typeName?.text;
-    const packageName = findPackageName(ts, sourceFile, typeName, packageJSON);
+    const packageName = findPackageName(ts, sourceFile, typeName);
     const importPath = findImportPath(
         ts,
         sourceFile,
         typeName,
-        packageJSON,
         modulePath
-    );
+    )?.replace(`${packageName}/`, "");
 
     return packageName && {
         name: typeName,
@@ -317,21 +318,43 @@ const validateJSDocComment = (fieldType, jsdocComment, node, moduleDoc) => {
         }
 
         if (!isValid) {
-            JSDocErrors.push(
-                `=== ERROR: Problem found with ${node}'s JSDoc comment in ${moduleDoc.path}: \n\t- @${tag.tag} tag is being used wrong or it's not part of ${fieldType} JSDoc tags`
-            );
+            logDocumentationError(moduleDoc.path, `Incorrect use of @${tag.tag}. Ensure it is part of ${fieldType} JSDoc tags.`)
         }
 
         return !!isValid;
     });
 };
 
-const getJSDocErrors = () => {
-    return JSDocErrors;
-};
+const logDocumentationError = (modulePath, message) => {
+    let moduleErrors = documentationErrors.get(modulePath);
+
+    if (!moduleErrors) {
+        documentationErrors.set(modulePath, []);
+        moduleErrors = documentationErrors.get(modulePath);
+    }
+
+    moduleErrors.push(message);
+}
+
+const displayDocumentationErrors = () => {
+    let errorsCount = 0;
+    [...documentationErrors.keys()].forEach(modulePath => {
+        const moduleErrors = documentationErrors.get(modulePath);
+
+        console.log(`=== ERROR: ${moduleErrors.length > 1 ? `${moduleErrors.length} problems` :  "Problem"} found in file: ${modulePath}:`)
+        moduleErrors.forEach(moduleError => {
+            errorsCount++;
+            console.log(`\t- ${moduleError}`)
+        })
+    })
+
+    if(errorsCount) {
+        throw new Error(`Found ${errorsCount} errors in the description of the public API.`);
+    }
+}
 
 const formatArrays = (typeText) => {
-	return typeText.replaceAll(/(\S+)\[\]/g, "Array<$1>")
+	return typeText?.replaceAll(/(\S+)\[\]/g, "Array<$1>")
 }
 
 export {
@@ -346,10 +369,11 @@ export {
     hasTag,
     findTag,
     findAllTags,
-    getJSDocErrors,
     getTypeRefs,
     normalizeDescription,
     formatArrays,
     isClass,
-    normalizeTagType
+    normalizeTagType,
+    displayDocumentationErrors,
+    logDocumentationError,
 };

package/lib/cem/validate.js

@@ -1,6 +1,10 @@
 const fs = require('fs');
 const Ajv = require('ajv');
 const path = require('path');
+const yargs = require('yargs/yargs')
+const { hideBin } = require('yargs/helpers')
+const argv = yargs(hideBin(process.argv))
+	.argv;
 
 // Load your JSON schema
 const extenalSchema = require('./schema.json');
@@ -36,28 +40,26 @@ const clearProps = (data) => {
     return data;
 }
 
-const inputDataExternal = clearProps(JSON.parse(JSON.stringify(inputDataInternal)));
-
 const ajv = new Ajv({ allowUnionTypes: true, allError: true })
-
 let validate = ajv.compile(internalSchema)
 
 // Validate the JSON data against the schema
-if (validate(inputDataInternal)) {
-    console.log('Validation internal custom-elements successful');
-} else {
-    console.error('Validation of internal custom-elements failed');
-    // console.error('Validation of internal custom-elements failed:', validate.errors);
+if (argv.dev) {
+    if (validate(inputDataInternal)) {
+        console.log('Internal custom  element manifest is validated successfully');
+    } else {
+        throw new Error(`Validation of internal custom elements manifest failed: ${validate.errors}`);
+    }
 }
 
+const inputDataExternal = clearProps(JSON.parse(JSON.stringify(inputDataInternal)));
 validate = ajv.compile(extenalSchema)
 
 // Validate the JSON data against the schema
 if (validate(inputDataExternal)) {
-    console.log('Validation external custom-elements successful');
+    console.log('Custom element manifest is validated successfully');
     fs.writeFileSync(inputFilePath, JSON.stringify(inputDataExternal, null, 2), 'utf8');
     fs.writeFileSync(inputFilePath.replace("custom-elements", "custom-elements-internal"), JSON.stringify(inputDataInternal, null, 2), 'utf8');
-} else {
-    console.error('Validation of external custom-elements failed:');
-    // console.error('Validation of external custom-elements failed:', ajv.errorsText(validate.errors));
-}
+} else if (argv.dev) {
+    throw new Error(`Validation of public custom elements manifest failed: ${validate.errors}`);
+    }

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

@@ -5,61 +5,40 @@ const path = require("path");
 const inputDir = process.argv[2];
 const outputDir = process.argv[3];
 
-const camelToKebabMap = new Map();
-const apiIndex = new Map();
-const forbiddenAttributeTypes = ["object", "array"];
-
-const camelToKebabCase = string => {
-	if (!camelToKebabMap.has(string)) {
-		const result = string.replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase();
-		camelToKebabMap.set(string, result);
-	}
-	return camelToKebabMap.get(string);
-};
+const moduleDeclarations = new Map();
 
 const generateJavaScriptExport = entity => {
 	return {
-		declaration: generateRefenrece(entity.name),
-		deprecated: !!entity.deprecated,
+		declaration: {
+			name: entity.basename,
+			module: `dist/${entity.resource}`,
+		},
 		kind: "js",
 		name: "default",
 	};
 };
 
 const generateCustomElementExport = entity => {
+	if (!entity.tagname) return;
+
 	return {
 		declaration: {
 			name: entity.basename,
-			module: `${entity.module}.js`,
+			module: `dist/${entity.resource}`,
 		},
-		deprecated: !!entity.deprecated,
 		kind: "custom-element-definition",
-		name: entity.tagname,
-	};
-};
-
-const generateJavaScriptModule = entity => {
-	return {
-		kind: "javascript-module",
-		path: `${entity.basename}.js`,
-		declarations: [
-			generateCustomElementDeclaration(entity),
-		],
-		exports: [
-			generateJavaScriptExport(entity),
-			generateCustomElementExport(entity),
-		],
+		name: entity.basename,
 	};
 };
 
 const generateSingleClassField = classField => {
 	let generatedClassField = {
-		deprecated: !!classField.deprecated,
 		kind: "field",
 		name: classField.name,
-		privacy: classField.visibility,
-		static: !!classField.static,
 		type: generateType(classField.type),
+		privacy: classField.visibility,
+		deprecated: !!classField.deprecated || undefined,
+		static: !!classField.static || undefined,
 	};
 
 	if (classField.defaultValue) {
@@ -75,7 +54,7 @@ const generateSingleClassField = classField => {
 
 const generateSingleParameter = parameter => {
 	let generatedParameter = {
-		deprecated: !!parameter.deprecated,
+		deprecated: !!parameter.deprecated || undefined,
 		name: parameter.name,
 		type: generateType(parameter.type),
 	};
@@ -86,6 +65,7 @@ const generateSingleParameter = parameter => {
 
 	if (parameter.optional) {
 		generatedParameter.optional = parameter.optional;
+		generatedParameter.default = parameter.defaultValue;
 	}
 
 	return generatedParameter;
@@ -101,7 +81,7 @@ const generateParameters = (parameters) => {
 
 const generateSingleClassMethod = classMethod => {
 	let generatedClassMethod = {
-		deprecated: !!classMethod.deprecated,
+		deprecated: !!classMethod.deprecated || undefined,
 		kind: "method",
 		name: classMethod.name,
 		privacy: classMethod.visibility,
@@ -122,7 +102,7 @@ const generateSingleClassMethod = classMethod => {
 		};
 
 		if (classMethod.returnValue.description) {
-			generatedClassMethod.return.description = classMethod.returnValue.type;
+			generatedClassMethod.return.description = classMethod.returnValue.description;
 		}
 	}
 
@@ -150,47 +130,16 @@ const generateMembers = (classFields, classMethods) => {
 };
 
 const generateType = type => {
-	const dataType = apiIndex.get(type);
-
 	return {
-		text: dataType && dataType.name.includes(".types.") ?
-			filterPublicApi(dataType.properties)
-				.map(prop => `"${prop.name}"`)
-				.join(" | ") : type,
-	};
-};
-
-const generateSingleAttribute = attribute => {
-	let generatedAttribute = {
-		default: attribute.defaultValue,
-		deprecated: !!attribute.deprecated,
-		fieldName: attribute.name,
-		name: camelToKebabCase(attribute.name),
-		type: generateType(attribute.type),
+		text: type,
 	};
-
-	if (attribute.description) {
-		generatedAttribute.description = attribute.description;
-	}
-
-	return generatedAttribute;
-};
-
-const generateAttributes = attributes => {
-	attributes = attributes.reduce((newAttributesArray, attribute) => {
-		newAttributesArray.push(generateSingleAttribute(attribute));
-
-		return newAttributesArray;
-	}, []);
-
-	return attributes;
 };
 
 const generateSingleEvent = event => {
 	let generatedEvent = {
-		deprecated: !!event.deprecated,
+		deprecated: !!event.deprecated || undefined,
 		name: event.name,
-		type: event.native === "true" ? "NativeEvent" : "CustomEvent",
+		type: generateType(event.native === "true" ? "NativeEvent" : "CustomEvent")
 	};
 
 	if (event.description) {
@@ -212,7 +161,7 @@ const generateEvents = events => {
 
 const generateSingleSlot = slot => {
 	return {
-		deprecated: !!slot.deprecated,
+		deprecated: !!slot.deprecated || undefined,
 		description: slot.description,
 		name: slot.name,
 	};
@@ -230,9 +179,9 @@ const generateSlots = slots => {
 
 const generateCustomElementDeclaration = entity => {
 	let generatedCustomElementDeclaration = {
-		deprecated: !!entity.deprecated,
+		deprecated: !!entity.deprecated || undefined,
 		customElement: true,
-		kind: entity.basename,
+		kind: entity.kind,
 		name: entity.basename,
 		tagName: entity.tagname,
 	};
@@ -241,9 +190,6 @@ const generateCustomElementDeclaration = entity => {
 	const events = filterPublicApi(entity.events);
 	const classFields = filterPublicApi(entity.properties);
 	const classMethods = filterPublicApi(entity.methods);
-	const attributes = classFields.filter(property => {
-		return property.noattribute !== "true" && property.readonly !== "true" && !forbiddenAttributeTypes.includes(property.type.toLowerCase());
-	});
 
 	if (slots.length) {
 		generatedCustomElementDeclaration.slots = generateSlots(slots);
@@ -253,10 +199,6 @@ const generateCustomElementDeclaration = entity => {
 		generatedCustomElementDeclaration.events = generateEvents(events);
 	}
 
-	if (attributes.length) {
-		generatedCustomElementDeclaration.attributes = generateAttributes(attributes);
-	}
-
 	if (entity.description) {
 		generatedCustomElementDeclaration.description = entity.description;
 	}
@@ -273,31 +215,8 @@ const generateCustomElementDeclaration = entity => {
 };
 
 const generateRefenrece = (entityName) => {
-	let packageName;
-	let basename;
-
-	if (!entityName) {
-		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")) {
-		packageName = "@ui5/webcomponents";
-	} else if (entityName.includes("sap.ui.webc.fiori")) {
-		packageName = "@ui5/webcomponents-fiori";
-	} else if (entityName.includes("sap.ui.webc.base")) {
-		packageName = "@ui5/webcomponents-base";
-	}
-
 	return {
-		module: `${basename}.js`,
-		name: `${basename}`,
-		package: packageName,
+		name: entityName,
 	};
 };
 
@@ -313,12 +232,37 @@ const generate = async () => {
 		modules: [],
 	};
 
-	file.symbols.forEach(entity => {
-		if (entity.tagname || entity.kind === "class") {
-			customElementsManifest.modules.push(generateJavaScriptModule(entity));
+	filterPublicApi(file.symbols).forEach(entity => {
+		let declaration = moduleDeclarations.get(entity.resource);
+
+		if (!declaration) {
+			moduleDeclarations.set(entity.resource, {
+				declarations: [],
+				exports: [],
+			});
+			declaration = moduleDeclarations.get(entity.resource);
+		}
+
+		if (entity.kind === "class" && entity.tagname) {
+			declaration.declarations.push(generateCustomElementDeclaration(entity));
+			declaration.exports.push(generateJavaScriptExport(entity));
+			declaration.exports.push(generateCustomElementExport(entity));
+		} else if (entity.kind === "class" && entity.static) {
+			declaration.exports.push(generateJavaScriptExport(entity));
 		}
 	});
 
+	[...moduleDeclarations.keys()].forEach(key => {
+		let declaration = moduleDeclarations.get(key);
+
+		customElementsManifest.modules.push({
+			kind: "javascript-module",
+			path: `dist/${key}`,
+			declarations: declaration.declarations,
+			exports: declaration.exports
+		})
+	})
+
 	await fs.writeFile(path.join(outputDir, "custom-elements.json"), JSON.stringify(customElementsManifest));
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ui5/webcomponents-tools",
-  "version": "1.22.0-rc.1",
+  "version": "1.22.0-rc.3",
   "description": "UI5 Web Components: webcomponents.tools",
   "author": "SAP SE (https://www.sap.com)",
   "license": "Apache-2.0",
@@ -79,5 +79,5 @@
     "esbuild": "^0.19.9",
     "yargs": "^17.5.1"
   },
-  "gitHead": "1a4ba450e7d222535ddaf4f1d3b0ff91b020bb2a"
+  "gitHead": "7ff123775e38dc646e3a1c70311e33b0c6d7105a"
 }

package/lib/esm-abs-to-rel/index.js

@@ -1,61 +0,0 @@
-const esprima = require("esprima");
-const escodegen = require("escodegen");
-
-const fs = require("fs").promises;
-const path = require("path");
-const basePath = process.argv[2];
-
-const convertImports = async (srcPath) => {
-	let changed = false;
-	let code = (await fs.readFile(srcPath)).toString();
-	if (code.includes("import(")) {
-		// esprima can't parse this, but it's from the project files
-		return;
-	}
-	const tree = esprima.parseModule(code);
-	const importer = srcPath.replace(basePath, "");
-	const importerDir = path.dirname(importer);
-	// console.log("-> ", importer);
-	tree.body.forEach(node => {
-		if (node.type === "ImportDeclaration") {
-			let importee = node.source.value;
-			if (importee.startsWith(".")) {
-				// add .js extension if missing
-				if (!importee.endsWith(".js")) {
-					node.source.value += ".js"
-					changed = true;
-				}
-				return;
-			}
-			let importeeDir = path.dirname(importee);
-			let importeeFile = path.basename(importee);
-			let relativePath = path.relative(importerDir, importeeDir);
-			if (relativePath.length === 0) {
-				relativePath = "."
-			}
-			if (!relativePath.startsWith(".")) {
-				relativePath = "./" + relativePath;
-			}
-
-			relativePath = relativePath.replace(/\\/g, "/"); // the browser expects unix paths
-			let relativeImport = `${relativePath}/${importeeFile}.js`;
-			// console.log(importee + " --> " + relativeImport);
-			node.source.value = relativeImport;
-			changed = true;
-		}
-	});
-
-	if (changed) {
-		return fs.writeFile(srcPath, escodegen.generate(tree));
-	}
-}
-
-const generate = async () => {
-	const { globby } = await import("globby");
-	const fileNames = await globby(basePath.replace(/\\/g, "/") + "**/*.js");
-	return Promise.all(fileNames.map(convertImports).filter(x => !!x));
-};
-
-generate().then(() => {
-	console.log("Success: Converted absolute imports to relative for files in:", basePath);
-});

package/lib/replace-global-core/index.js

@@ -1,25 +0,0 @@
-const fs = require("fs").promises;
-
-const basePath = process.argv[2];
-
-const replaceGlobalCoreUsage = async (srcPath) => {
-
-	const original = (await fs.readFile(srcPath)).toString();
-	let replaced = original.replace(/sap\.ui\.getCore\(\)/g, `Core`);
-
-	if (original !== replaced) {
-		replaced = `import Core from 'sap/ui/core/Core';
-		${replaced}`;
-		return fs.writeFile(srcPath, replaced);
-	}
-};
-
-const generate = async () => {
-	const { globby } = await import("globby");
-	const fileNames = await globby(basePath.replace(/\\/g, "/") + "**/*.js");
-	return Promise.all(fileNames.map(replaceGlobalCoreUsage).filter(x => !!x));
-};
-
-generate().then(() => {
-	console.log("Success: Replaced global core usage in:", basePath);
-});