@ui5/webcomponents-tools 0.0.0-ad923a2b7 → 0.0.0-ade0167ac

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

@@ -0,0 +1,271 @@
+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 moduleDeclarations = new Map();
+
+const generateJavaScriptExport = entity => {
+	return {
+		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: `dist/${entity.resource}`,
+		},
+		kind: "custom-element-definition",
+		name: entity.basename,
+	};
+};
+
+const generateSingleClassField = classField => {
+	let generatedClassField = {
+		kind: "field",
+		name: classField.name,
+		type: generateType(classField.type),
+		privacy: classField.visibility,
+		deprecated: !!classField.deprecated || undefined,
+		static: !!classField.static || undefined,
+	};
+
+	if (classField.defaultValue) {
+		generatedClassField.default = classField.defaultValue;
+	}
+
+	if (classField.description) {
+		generatedClassField.description = classField.description;
+	}
+
+	return generatedClassField;
+};
+
+const generateSingleParameter = parameter => {
+	let generatedParameter = {
+		deprecated: !!parameter.deprecated || undefined,
+		name: parameter.name,
+		type: generateType(parameter.type),
+	};
+
+	if (parameter.description) {
+		generatedParameter.description = parameter.description;
+	}
+
+	if (parameter.optional) {
+		generatedParameter.optional = parameter.optional;
+		generatedParameter.default = parameter.defaultValue;
+	}
+
+	return generatedParameter;
+};
+
+const generateParameters = (parameters) => {
+	return parameters.reduce((newParametersArray, parameter) => {
+		newParametersArray.push(generateSingleParameter(parameter));
+
+		return newParametersArray;
+	}, []);
+};
+
+const generateSingleClassMethod = classMethod => {
+	let generatedClassMethod = {
+		deprecated: !!classMethod.deprecated || undefined,
+		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.description;
+		}
+	}
+
+	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 => {
+	return {
+		text: type,
+	};
+};
+
+const generateSingleEvent = event => {
+	let generatedEvent = {
+		deprecated: !!event.deprecated || undefined,
+		name: event.name,
+		type: generateType(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 || undefined,
+		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 || undefined,
+		customElement: true,
+		kind: entity.kind,
+		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);
+
+	if (slots.length) {
+		generatedCustomElementDeclaration.slots = generateSlots(slots);
+	}
+
+	if (events.length) {
+		generatedCustomElementDeclaration.events = generateEvents(events);
+	}
+
+	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) => {
+	return {
+		name: entityName,
+	};
+};
+
+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: [],
+	};
+
+	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));
+};
+
+generate().then(() => {
+	console.log("Custom elements manifest generated.");
+});

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

@@ -0,0 +1,86 @@
+const fs = require("fs").promises;
+const path = require("path");
+
+const generateDynamicImportLines = async (fileNames, location, exclusionPatterns = []) => {
+  const packageName = JSON.parse(await fs.readFile("package.json")).name;
+  return fileNames
+    .filter((fileName) => !exclusionPatterns.some((pattern) => fileName.startsWith(pattern)))
+    .map((fileName) => {
+      const illustrationName = fileName.replace(".js", "");
+      const illustrationPath = `${location}/${illustrationName}`;
+      return `\t\tcase "${fileName.replace('.js', '')}": return (await import(/* webpackChunkName: "${packageName.replace("@", "").replace("/", "-")}-${illustrationName.toLowerCase()}" */ "${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, set, prefix = "") => {
+  return `// @ts-nocheck
+  import { registerIllustrationLoader } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
+
+export const loadIllustration = async (illustrationName) => {
+  const collectionAndPrefix = "${set}/${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(\`${set}/${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, set } = config;
+
+  const normalizedInputFolder = path.normalize(inputFolder);
+  const normalizedOutputFile = path.normalize(outputFile);
+
+  const illustrations = await getMatchingFiles(normalizedInputFolder, /^.*\.js$/);
+
+  const dynamicImports = await generateDynamicImportLines(illustrations, location, filterOut);
+  const availableIllustrations = generateAvailableIllustrationsArray(illustrations, filterOut);
+
+  const contentDynamic = generateDynamicImportsFileContent(dynamicImports, availableIllustrations, collection, set, 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],
+  set: process.argv[4],
+  collection: process.argv[5],
+  location: process.argv[6],
+  filterOut: process.argv.slice[7],
+};
+
+// Run the generation process
+generateIllustrations(config).catch((error) => {
+  console.error("Error generating illustrations:", error);
+});

package/lib/generate-json-imports/i18n.js

@@ -1,35 +1,42 @@
-const fs = require("fs");
+const fs = require("fs").promises;
 const path = require('path');
-const mkdirp = require("mkdirp");
 
-const packageName = JSON.parse(fs.readFileSync("package.json")).name;
+const isTypeScript = process.env.UI5_TS;
+const ext = isTypeScript ? 'ts' : 'js';
 
-const inputFolder = path.normalize(process.argv[2]);
-const outputFile = path.normalize(`${process.argv[3]}/i18n.js`);
+const generate = async () => {
+
+	const packageName = JSON.parse(await fs.readFile("package.json")).name;
+
+	const inputFolder = path.normalize(process.argv[2]);
+	const outputFile = path.normalize(`${process.argv[3]}/i18n-static.${ext}`);
+	const outputFileDynamic = path.normalize(`${process.argv[3]}/i18n.${ext}`);
 
 // All languages present in the file system
-const files = fs.readdirSync(inputFolder);
-const languages = files.map(file => {
-  const matches = file.match(/messagebundle_(.+?).json$/);
-  return matches ? matches[1] : undefined;
-}).filter(key => !!key);
+	const files = await fs.readdir(inputFolder);
+	const languages = files.map(file => {
+		const matches = file.match(/messagebundle_(.+?).json$/);
+		return matches ? matches[1] : undefined;
+	}).filter(key => !!key);
 
-let content;
+	let contentStatic, contentDynamic;
 
 // No i18n - just import dependencies, if any
-if (languages.length === 0) {
-  content = ``;
+	if (languages.length === 0) {
+		contentStatic = "";
+		contentDynamic = "";
 // There is i18n - generate the full file
-} else {
+	} else {
+		// Keys for the array
+		const languagesKeysString = languages.map(key => `"${key}": _${key},`).join("\n\t");
+		const languagesKeysStringArray = languages.map(key => `"${key}",`).join("\n\t");
 
-  // Keys for the array
-  const languagesKeysString = languages.map(key => `${key},`).join("\n\t");
+		// Actual imports for json assets
+		const assetsImportsString = languages.map(key => `import _${key} from "../assets/i18n/messagebundle_${key}.json";`).join("\n");
 
-  // Actual imports for json assets
-  const assetsImportsString = languages.map(key => `import ${key} from "../assets/i18n/messagebundle_${key}.json";`).join("\n");
-
-  // Resulting file content
-  content = `import { registerI18nBundle } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
+		// static imports
+		contentStatic = `// @ts-nocheck
+import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
 
 ${assetsImportsString}
 
@@ -37,17 +44,60 @@ const bundleMap = {
 	${languagesKeysString}
 };
 
-const allEntriesInlined = Object.entries(bundleMap).every(([_key, value]) => typeof (value) === "object");
-
-if (allEntriesInlined) {
-	console.warn(\`Inefficient bundling detected: consider bundling i18n imports as URLs instead of inlining them.
-See rollup-plugin-url or webpack file-loader for more information.
-Suggested pattern: "assets\\\\\\/.*\\\\\\.json"\`);
+const fetchMessageBundle = async (localeId) => {
+	if (typeof bundleMap[localeId] === "object") {
+		// inlined from build
+		throw new Error("[i18n] Inlined JSON not supported with static imports of assets. Use dynamic imports of assets or configure JSON imports as URLs")
+	}
+	return (await fetch(bundleMap[localeId])).json()
 }
 
-registerI18nBundle("${packageName}", bundleMap);
+const localeIds = [${languagesKeysStringArray}];
+
+localeIds.forEach(localeId => {
+	registerI18nLoader("${packageName}", localeId, fetchMessageBundle);
+});
 `;
+
+		// Actual imports for json assets
+		const dynamicImportsString = languages.map(key => `		case "${key}": return (await import(/* webpackChunkName: "${packageName.replace("@", "").replace("/", "-")}-messagebundle-${key}" */ "../assets/i18n/messagebundle_${key}.json")).default;`).join("\n");
+
+		// Resulting file content
+		contentDynamic = `// @ts-nocheck
+import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
+
+	const importMessageBundle = async (localeId) => {
+		switch (localeId) {
+	${dynamicImportsString}
+			default: throw "unknown locale"
+		}
+	}
+
+	const importAndCheck = async (localeId) => {
+		const data = await importMessageBundle(localeId);
+		if (typeof data === "string" && data.endsWith(".json")) {
+			throw new Error(\`[i18n] Invalid bundling detected - dynamic JSON imports bundled as URLs. Switch to inlining JSON files from the build or use 'import ".../Assets-static.js"'. Check the \"Assets\" documentation for more information.\`);
+		}
+		return data;
+	}
+
+	const localeIds = [${languagesKeysStringArray}];
+
+	localeIds.forEach(localeId => {
+		registerI18nLoader("${packageName}", localeId, importAndCheck);
+	});
+	`;
+
+
+	}
+
+	await fs.mkdir(path.dirname(outputFile), { recursive: true });
+	return Promise.all([
+		fs.writeFile(outputFile, contentStatic),
+		fs.writeFile(outputFileDynamic, contentDynamic),
+	]);
 }
 
-mkdirp.sync(path.dirname(outputFile));
-fs.writeFileSync(outputFile, content);
+generate().then(() => {
+	console.log("Generated i18n JSON imports.");
+});

package/lib/generate-json-imports/themes.js

@@ -1,33 +1,85 @@
-const fs = require("fs");
+const fs = require("fs").promises;
 const path = require('path');
-const mkdirp = require("mkdirp");
 const assets = require("../../assets-meta.js");
 
-const outputFile = path.normalize(`${process.argv[2]}/Themes.js`);
+const isTypeScript = process.env.UI5_TS;
+const ext = isTypeScript ? 'ts' : 'js';
 
-const optionalThemes = assets.themes.all.filter(theme => theme !== assets.themes.default);
+const generate = async () => {
+	const inputFolder = path.normalize(process.argv[2]);
+	const outputFile = path.normalize(`${process.argv[3]}/Themes-static.${ext}`);
+	const outputFileDynamic = path.normalize(`${process.argv[3]}/Themes.${ext}`);
 
-const packageName = JSON.parse(fs.readFileSync("package.json")).name;
+// All supported optional themes
+	const allThemes = assets.themes.all;
 
-const importLines = optionalThemes.map(theme => `import ${theme} from "../assets/themes/${theme}/parameters-bundle.css.json";`).join("\n");
-const isInlinedCondition = optionalThemes.map(theme => `isInlined(${theme})`).join(" || ");
-const registerLines = optionalThemes.map(theme => `registerThemeProperties("${packageName}", "${theme}", ${theme});`).join("\n");
+// All themes present in the file system
+	const dirs = await fs.readdir(inputFolder);
+	const themesOnFileSystem = dirs.map(dir => {
+		const matches = dir.match(/sap_.*$/);
+		return matches ? dir : undefined;
+	}).filter(key => !!key && allThemes.includes(key));
 
-// Resulting file content
-const content = `import { registerThemeProperties } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
+	const packageName = JSON.parse(await fs.readFile("package.json")).name;
+
+	const importLines = themesOnFileSystem.map(theme => `import ${theme} from "../assets/themes/${theme}/parameters-bundle.css.json";`).join("\n");
+	const themeUrlsByName = "{\n" + themesOnFileSystem.join(",\n") + "\n}";
+	const availableThemesArray = `[${themesOnFileSystem.map(theme => `"${theme}"`).join(", ")}]`;
+	const dynamicImportLines = themesOnFileSystem.map(theme => `\t\tcase "${theme}": return (await import(/* webpackChunkName: "${packageName.replace("@", "").replace("/", "-")}-${theme.replace("_", "-")}-parameters-bundle" */"../assets/themes/${theme}/parameters-bundle.css.json")).default;`).join("\n");
+
+
+// static imports file content
+	const contentStatic = `// @ts-nocheck
+import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
 
 ${importLines}
 
+const themeUrlsByName = ${themeUrlsByName};
 const isInlined = obj => typeof (obj) === "object";
 
-if (${isInlinedCondition}) {
-	console.warn(\`Inefficient bundling detected: consider bundling theme properties imports as URLs instead of inlining them.
-See rollup-plugin-url or webpack file-loader for more information.
-Suggested pattern: "assets\\\\\\/.*\\\\\\.json"\`);
-}
+const loadThemeProperties = async (themeName) => {
+	if (typeof themeUrlsByName[themeName] === "object") {
+		// inlined from build
+		throw new Error("[themes] Inlined JSON not supported with static imports of assets. Use dynamic imports of assets or configure JSON imports as URLs");
+	}
+	return (await fetch(themeUrlsByName[themeName])).json();
+};
+
+${availableThemesArray}
+  .forEach(themeName => registerThemePropertiesLoader("${packageName}", themeName, loadThemeProperties));
+`;
+
+
+// dynamic imports file content
+	const contentDynamic = `// @ts-nocheck
+import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
+
+const loadThemeProperties = async (themeName) => {
+	switch (themeName) {
+${dynamicImportLines}
+		default: throw "unknown theme"
+	}
+};
 
-${registerLines};
+const loadAndCheck = async (themeName) => {
+	const data = await loadThemeProperties(themeName);
+	if (typeof data === "string" && data.endsWith(".json")) {
+		throw new Error(\`[themes] Invalid bundling detected - dynamic JSON imports bundled as URLs. Switch to inlining JSON files from the build or use 'import ".../Assets-static.js"'. Check the \"Assets\" documentation for more information.\`);
+	}
+	return data;
+};
+
+${availableThemesArray}
+  .forEach(themeName => registerThemePropertiesLoader("${packageName}", themeName, loadAndCheck));
 `;
 
-mkdirp.sync(path.dirname(outputFile));
-fs.writeFileSync(outputFile, content);
+	await fs.mkdir(path.dirname(outputFile), { recursive: true });
+	return Promise.all([
+		fs.writeFile(outputFile, contentStatic),
+		fs.writeFile(outputFileDynamic, contentDynamic)
+	]);
+};
+
+generate().then(() => {
+	console.log("Generated themes JSON imports.");
+});

package/lib/hbs2lit/index.js

@@ -1,5 +1,3 @@
-const compiler = require("./src/compiler");
+const hbs2lit = require("./src/compiler");
 
-module.exports = {
-	compileString: compiler.compileString
-};
+module.exports = hbs2lit;

package/lib/hbs2lit/src/compiler.js

@@ -5,19 +5,32 @@ const includesReplacer = require("./includesReplacer");
 const svgProcessor = require("./svgProcessor");
 
 const removeWhiteSpaces = (source) => {
-	return source.replace(/\n+/g, "").replace(/\s+</g, "<").replace(/}}\s+{{/g, "}}{{");
+	return source
+		.replace(/\s*\r*\n+\s*/g, " ") // Replace new lines and all whitespace between them with a space
+		.replace(/\s*<\s*/g, "<") // Strip whitespace round <
+		.replace(/\s*>\s*/g, ">") // Strip whitespace round >
+		.replace(/}}\s+{{/g, "}}{{"); // Remove whitespace between }} and {{
 };
 
-const compileString = async (sInput, config) => {
-	let sPreprocessed = sInput;
+const hbs2lit = async (file, componentName) => {
+	let sPreprocessed = await includesReplacer.replace(file);
 
-	sPreprocessed = await includesReplacer.replace(sPreprocessed, config);
 	sPreprocessed = removeWhiteSpaces(sPreprocessed);
 
+	const blockSignature = process.env.UI5_TS ? `this: ${componentName}` : ""
+
+	// icons hack
+	if (sPreprocessed.startsWith("<g ") || sPreprocessed.startsWith("<g>")) {
+		return `
+		function block0 (${blockSignature}) {
+			return svg\`${sPreprocessed}\`
+		}`;
+	}
+
 	const ast = Handlebars.parse(sPreprocessed);
 
 	const pv = new PartialsVisitor();
-	const lv = new HTMLLitVisitor();
+	const lv = new HTMLLitVisitor(componentName);
 
 	let result = "";
 
@@ -27,13 +40,21 @@ const compileString = async (sInput, config) => {
 	lv.accept(ast);
 
 	for (let key in lv.blocks) {
-		result += lv.blocks[key] + "\n";
+		let block = lv.blocks[key];
+
+		if (block.match(/scopeTag/)) {
+			// const matches = block.match(/^(.*?)( => )(.*?);$/);
+			const matches = block.match(/^(function .*? \{ return )(.*?);\}$/);
+			const scopedCode = matches[2];
+			const normalCode = scopedCode.replace(/\${scopeTag\("/g, "").replace(/", tags, suffix\)}/g, "");
+			block = `${matches[1]}suffix ? ${scopedCode} : ${normalCode};}`;
+		}
+
+		result += block + "\n";
 	}
 
 	result = svgProcessor.process(result);
 	return result;
 };
 
-module.exports = {
-	compileString
-};
+module.exports = hbs2lit;