@ui5/webcomponents-tools 0.0.0-ef27ca1aa → 0.0.0-f24ff9019

package/lib/create-new-component/tsFileContentTemplate.js

@@ -0,0 +1,80 @@
+const tsFileContentTemplate = (componentName, tagName, library, packageName) => {
+	return `import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
+import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
+import property from "@ui5/webcomponents-base/dist/decorators/property.js";
+import slot from "@ui5/webcomponents-base/dist/decorators/slot.js";
+import event from "@ui5/webcomponents-base/dist/decorators/event.js";
+import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
+
+import ${componentName}Template from "./generated/templates/${componentName}Template.lit.js";
+
+// Styles
+import ${componentName}Css from "./generated/themes/${componentName}.css.js";
+
+/**
+ * @class
+ *
+ * <h3 class="comment-api-title">Overview</h3>
+ *
+ *
+ * <h3>Usage</h3>
+ *
+ * For the <code>${tagName}</code>
+ * <h3>ES6 Module Import</h3>
+ *
+ * <code>import ${packageName}/dist/${componentName}.js";</code>
+ *
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webc.${library}.${componentName}
+ * @extends sap.ui.webc.base.UI5Element
+ * @tagname ${tagName}
+ * @public
+ */
+@customElement({
+	tag: "${tagName}",
+	renderer: litRender,
+	styles: ${componentName}Css,
+	template: ${componentName}Template,
+	dependencies: [],
+})
+
+/**
+ * Example custom event.
+ * Please keep in mind that all public events should be documented in the API Reference as shown below.
+ *
+ * @event sap.ui.webc.${library}.${componentName}#interact
+ * @public
+ */
+@event("interact", { detail: { /* event payload ( optional ) */ } })
+class ${componentName} extends UI5Element {
+	/**
+	 * Defines the value of the component.
+	 *
+	 * @type {string}
+	 * @name sap.ui.webc.${library}.${componentName}.prototype.value
+	 * @defaultvalue ""
+	 * @public
+	 */
+	@property()
+	value!: string;
+
+	/**
+	 * Defines the text of the component.
+	 *
+	 * @type {Node[]}
+	 * @name sap.ui.webc.${library}.${componentName}.prototype.default
+	 * @slot
+	 * @public
+	 */
+	@slot({ type: Node, "default": true })
+	text!: Array<Node>;
+}
+
+${componentName}.define();
+
+export default ${componentName};
+`;
+};
+
+module.exports = tsFileContentTemplate;

package/lib/dev-server/custom-hot-update-plugin.js

@@ -0,0 +1,39 @@
+const fs = require("fs");
+
+/**
+ * A change is observed on MacOS since 13.5, where the build generates a large amount
+ * of JSON file that spotlight search has to index, as they are considered new files.
+ * 
+ * Starting the vitejs dev server reads all of these files and this triggers the indexing.
+ * The indexing has a side effect of changing some file metadata (can be checked with `mdls <path_to_file>`).
+ * This metadata change is changing the ctime of the file, but not the mtime. This can be checked with `stat -x <path_to_file>
+ * 
+ * Essentially only metadata is changed, not content. This should not cause a page refresh,
+ * but chokidar reports this change and vite refreshes the page.
+ * The indexing is running with a 10 second interval, so for roughtly 20 minutes vite is refreshing the page every 10 seconds
+ * 
+ * This plugin checks if the file causing the refresh is a generated json file (dist/*.json) and if ctime is changed after mtime
+ * In that case, returing an empty array tells vitejs that a custom update will be made by the plugin,
+ * which is in effect ignoring the page refresh.
+ */
+
+const customHotUpdate = async () => {
+	return {
+		name: 'custom-hot-update',
+		handleHotUpdate(ctx) {
+			// custom check for generated json files
+			if (ctx.file.includes("dist/") && ctx.file.endsWith(".json")) {
+				const stat = fs.statSync(ctx.file);
+
+				// metadata change only
+				if (stat.ctime > stat.mtime) {
+					// uncomment for debugging
+					// console.log("ignoring hot update for:", ctx.file);
+					return [];
+				}
+			}
+		}
+	}
+};
+
+module.exports = customHotUpdate;

package/lib/dev-server/dev-server.js

@@ -0,0 +1,66 @@
+const fs = require("fs/promises");
+const { createServer } = require('vite');
+const yargs = require('yargs/yargs')
+const { hideBin } = require('yargs/helpers')
+
+const argv = yargs(hideBin(process.argv))
+	.alias("c", "config")
+	.argv;
+
+const startVite = async (port) => {
+	const server = await createServer({
+		configFile: argv.config,
+		server: {
+			port: port,
+			strictPort: true,
+			open: true,
+			host: true,
+		},
+		logLevel: 'info',
+		clearScreen: false,
+	})
+	await server.listen()
+	server.printUrls()
+	return server;
+};
+
+const rmPortFile = async () => {
+	// exit handler must be sync
+	try {
+		await fs.rm(".dev-server-port");
+	} catch (e) {}
+	process.exit();
+}
+
+["exit", "SIGINT", "SIGUSR1", "SIGUSR2", "uncaughtException", "SIGTERM"].forEach((eventType) => {
+	process.on(eventType, rmPortFile);
+});
+
+(async () => {
+	let retries = 10;
+	let port = 8080;
+	while (retries--) {
+		console.log(`taking port ${port}`);
+		await fs.writeFile(".dev-server-port", `${port}`);
+		try {
+			// execSync(command, {stdio: 'pipe'});
+			const server = await startVite(port);
+			if (server) {
+				// server started, don't try other ports
+				break;
+			}
+		} catch (e) {
+			// uncomment for debug
+			// console.log(e.toString());
+			if (e.toString().includes("already in use")) {
+				console.log(`Port ${port} already in use`)
+				port++;
+				continue;
+			}
+			// other error or CTRL-C
+			process.exit();
+		}
+		// no error normal exit
+		// process.exit();
+	}
+})();

package/lib/dev-server/virtual-index-html-plugin.js

@@ -0,0 +1,52 @@
+const virtualIndexPlugin = async () => {
+	const path = await import("path");
+	const { globby } = await import("globby");
+	const files = await globby(["test/pages/**/*.html", "packages/*/test/pages/**/*.html"]);
+
+	const pagesPerFolder = {};
+	files.forEach(file => {
+		let folder = pagesPerFolder[path.dirname(file)] = pagesPerFolder[path.dirname(file)] || [];
+		folder.push(path.basename(file));
+	});
+
+	const rollupInput = {};
+
+	files.forEach(file => {
+		rollupInput[file] = path.resolve(process.cwd(), file);
+	})
+
+	return {
+		name: 'virtual-index-html',
+		config() {
+			return {
+				build: {
+					rollupOptions: {
+						input: rollupInput
+					}
+				}
+			}
+		},
+		configureServer(server) {
+			server.middlewares.use((req, res, next) => {
+				if (req.url === "/") {
+					const folders = Object.keys(pagesPerFolder);
+
+					res.statusCode = 200;
+					res.setHeader("Content-Type", "text/html; charset=utf-8");
+					res.end(`${folders.map(folder => {
+						const pages = pagesPerFolder[folder];
+						return `<h1>${folder}</h1>
+							${pages.map(page => {
+								return `<li><a href='${folder}/${page}'>${page}</a></li>`
+							}).join("")}
+						`
+					}).join("")}`);
+				} else {
+					next();
+				}
+			})
+		},
+	}
+};
+
+module.exports = virtualIndexPlugin;

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

@@ -0,0 +1,58 @@
+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;
+	// console.log("scanning imports of", srcPath);
+	let code = (await fs.readFile(srcPath)).toString();
+	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/generate-custom-elements-manifest/index.js

@@ -0,0 +1,327 @@
+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 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 generateJavaScriptExport = entity => {
+	return {
+		declaration: generateRefenrece(entity.name),
+		deprecated: !!entity.deprecated,
+		kind: "js",
+		name: "default",
+	};
+};
+
+const generateCustomElementExport = entity => {
+	return {
+		declaration: {
+			name: entity.basename,
+			module: `${entity.module}.js`,
+		},
+		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),
+		],
+	};
+};
+
+const generateSingleClassField = classField => {
+	let generatedClassField = {
+		deprecated: !!classField.deprecated,
+		kind: "field",
+		name: classField.name,
+		privacy: classField.visibility,
+		static: !!classField.static,
+		type: generateType(classField.type),
+	};
+
+	if (classField.defaultValue) {
+		generatedClassField.default = classField.defaultValue;
+	}
+
+	if (classField.description) {
+		generatedClassField.description = classField.description;
+	}
+
+	return generatedClassField;
+};
+
+const generateSingleParameter = parameter => {
+	let generatedParameter = {
+		deprecated: !!parameter.deprecated,
+		name: parameter.name,
+		type: generateType(parameter.type),
+	};
+
+	if (parameter.description) {
+		generatedParameter.description = parameter.description;
+	}
+
+	if (parameter.optional) {
+		generatedParameter.optional = parameter.optional;
+	}
+
+	return generatedParameter;
+};
+
+const generateParameters = (parameters) => {
+	return parameters.reduce((newParametersArray, parameter) => {
+		newParametersArray.push(generateSingleParameter(parameter));
+
+		return newParametersArray;
+	}, []);
+};
+
+const generateSingleClassMethod = classMethod => {
+	let generatedClassMethod = {
+		deprecated: !!classMethod.deprecated,
+		kind: "method",
+		name: classMethod.name,
+		privacy: classMethod.visibility,
+		static: classMethod.static,
+	};
+
+	if (classMethod.description) {
+		generatedClassMethod.description = classMethod.description;
+	}
+
+	if (classMethod.parameters && classMethod.parameters.length) {
+		generatedClassMethod.parameters = generateParameters(classMethod.parameters);
+	}
+
+	if (classMethod.returnValue) {
+		generatedClassMethod.return = {
+			type: generateType(classMethod.returnValue.type),
+		};
+
+		if (classMethod.returnValue.description) {
+			generatedClassMethod.return.description = classMethod.returnValue.type;
+		}
+	}
+
+	return generatedClassMethod;
+};
+
+const generateClassFields = classFields => {
+	return classFields.reduce((newClassFieldsArray, classField) => {
+		newClassFieldsArray.push(generateSingleClassField(classField));
+
+		return newClassFieldsArray;
+	}, []);
+};
+
+const generateClassMethods = classMethods => {
+	return classMethods.reduce((newClassMethodsArray, classMethod) => {
+		newClassMethodsArray.push(generateSingleClassMethod(classMethod));
+
+		return newClassMethodsArray;
+	}, []);
+};
+
+const generateMembers = (classFields, classMethods) => {
+	return [...generateClassFields(classFields), ...generateClassMethods(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),
+	};
+
+	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,
+		name: event.name,
+		type: event.native === "true" ? "NativeEvent" : "CustomEvent",
+	};
+
+	if (event.description) {
+		generatedEvent.description = event.description;
+	}
+
+	return generatedEvent;
+};
+
+const generateEvents = events => {
+	events = events.reduce((newEventsArray, event) => {
+		newEventsArray.push(generateSingleEvent(event));
+
+		return newEventsArray;
+	}, []);
+
+	return events;
+};
+
+const generateSingleSlot = slot => {
+	return {
+		deprecated: !!slot.deprecated,
+		description: slot.description,
+		name: slot.name,
+	};
+};
+
+const generateSlots = slots => {
+	slots = slots.reduce((newSlotsArray, event) => {
+		newSlotsArray.push(generateSingleSlot(event));
+
+		return newSlotsArray;
+	}, []);
+
+	return slots;
+};
+
+const generateCustomElementDeclaration = entity => {
+	let generatedCustomElementDeclaration = {
+		deprecated: !!entity.deprecated,
+		customElement: true,
+		kind: entity.basename,
+		name: entity.basename,
+		tagName: entity.tagname,
+	};
+
+	const slots = filterPublicApi(entity.slots);
+	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);
+	}
+
+	if (events.length) {
+		generatedCustomElementDeclaration.events = generateEvents(events);
+	}
+
+	if (attributes.length) {
+		generatedCustomElementDeclaration.attributes = generateAttributes(attributes);
+	}
+
+	if (entity.description) {
+		generatedCustomElementDeclaration.description = entity.description;
+	}
+
+	if (classFields.length || classMethods.length) {
+		generatedCustomElementDeclaration.members = generateMembers(classFields, classMethods);
+	}
+
+	if (entity.extends && entity.extends !== "HTMLElement") {
+		generatedCustomElementDeclaration.superclass = generateRefenrece(entity.extends);
+	}
+
+	return generatedCustomElementDeclaration;
+};
+
+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,
+	};
+};
+
+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: [],
+	};
+
+	file.symbols.forEach(entity => {
+		if (entity.tagname || entity.kind === "class") {
+			customElementsManifest.modules.push(generateJavaScriptModule(entity));
+		}
+	});
+
+	await fs.writeFile(path.join(outputDir, "custom-elements.json"), JSON.stringify(customElementsManifest));
+};
+
+generate().then(() => {
+	console.log("Custom elements manifest generated.");
+});

package/lib/generate-js-imports/illustrations.js

@@ -0,0 +1,83 @@
+const fs = require("fs").promises;
+const path = require("path");
+
+const generateDynamicImportLines = (fileNames, location, exclusionPatterns = []) => {
+  return fileNames
+    .filter((fileName) => !exclusionPatterns.some((pattern) => fileName.startsWith(pattern)))
+    .map((fileName) => {
+      const illustrationPath = `${location}/${fileName.replace(".js", "")}`;
+      return `\t\tcase "${fileName.replace('.js', '')}": return (await import("${illustrationPath}.js")).default;`;
+    })
+    .join("\n");
+};
+
+const generateAvailableIllustrationsArray = (fileNames, exclusionPatterns = []) => {
+  return JSON.stringify(
+    fileNames
+      .filter((fileName) => !exclusionPatterns.some((pattern) => fileName.startsWith(pattern)))
+      .map((fileName) => fileName.replace(".js", ""))
+  );
+};
+
+const generateDynamicImportsFileContent = (dynamicImports, availableIllustrations, collection, prefix = "") => {
+  return `import { registerIllustrationLoader } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
+
+export const loadIllustration = async (illustrationName) => {
+  const collectionAndPrefix = "${collection}/${prefix}";
+  const cleanIllustrationName = illustrationName.startsWith(collectionAndPrefix) ? illustrationName.replace(collectionAndPrefix, "") : illustrationName;
+  switch (cleanIllustrationName) {
+${dynamicImports}
+    default:
+      throw new Error("[Illustrations] Illustration not found: " + illustrationName);
+  }
+};
+
+const loadAndCheck = async (illustrationName) => {
+  const data = await loadIllustration(illustrationName);
+  return data;
+};
+
+${availableIllustrations}.forEach((illustrationName) =>
+  registerIllustrationLoader(\`${collection}/${prefix}\${illustrationName}\`, loadAndCheck)
+);
+`;
+};
+
+const getMatchingFiles = async (folder, pattern) => {
+  const dir = await fs.readdir(folder);
+  return dir.filter((fileName) => fileName.match(pattern));
+};
+
+const generateIllustrations = async (config) => {
+  const { inputFolder, outputFile, collection, location, prefix, filterOut } = config;
+
+  const normalizedInputFolder = path.normalize(inputFolder);
+  const normalizedOutputFile = path.normalize(outputFile);
+
+  const illustrations = await getMatchingFiles(normalizedInputFolder, /^.*\.js$/);
+
+  const dynamicImports = generateDynamicImportLines(illustrations, location, filterOut);
+  const availableIllustrations = generateAvailableIllustrationsArray(illustrations, filterOut);
+
+  const contentDynamic = generateDynamicImportsFileContent(dynamicImports, availableIllustrations, collection, prefix);
+
+  await fs.mkdir(path.dirname(normalizedOutputFile), { recursive: true });
+  await fs.writeFile(normalizedOutputFile, contentDynamic);
+
+  console.log(`Generated ${normalizedOutputFile}`);
+};
+
+// Parse configuration from command-line arguments
+const config = {
+  inputFolder: process.argv[2],
+  outputFile: process.argv[3],
+  collection: process.argv[4],
+  location: process.argv[5],
+  prefix: process.argv[6],
+  filterOut: process.argv.slice(7),
+};
+
+// Run the generation process
+generateIllustrations(config).catch((error) => {
+  console.error("Error generating illustrations:", error);
+});