@ui5/webcomponents-tools 0.0.0-4180fe799 → 0.0.0-4738ea0dc

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

@@ -0,0 +1,72 @@
+const fs = require("fs").promises;
+const path = require('path');
+
+const generate = async () => {
+	const fioriInputFolder = path.normalize(process.argv[2]);
+	const tntInputFolder = path.normalize(process.argv[3]);
+	const outputFile = path.normalize(`${process.argv[4]}/Illustrations.js`);
+
+	const dir = await fs.readdir(fioriInputFolder);
+	const fioriIllustrationsOnFileSystem = dir.map(illustrationName => {
+		const fioriMatches = illustrationName.match(/.*\.js$/);
+		return fioriMatches ? illustrationName : undefined;
+	}).filter(key => !!key);
+
+	const tntDir = await fs.readdir(tntInputFolder);
+	const tntIllustrationsOnFileSystem = tntDir.map(illustrationName => {
+		const tntMatches = illustrationName.match(/.*\.js$/);
+		return tntMatches ? illustrationName : undefined;
+	}).filter(key => !!key);
+
+	// dynamic imports for Fiori illustrations
+	const fioriAvailableIllustrationsArray = `[${fioriIllustrationsOnFileSystem.filter(
+		// skipping the items starting with sapIllus-Dialog, sapIllus-Scene, sapIllus-Spot since they are included in the illustration's js file
+		line => !line.startsWith("sapIllus-Dialog") && !line.startsWith("sapIllus-Scene") && !line.startsWith("sapIllus-Spot") && !line.startsWith("AllIllustrations")).map(illustrationName => `"${illustrationName.replace('.js', '')}"`).join(", ")}]`;
+
+	const fioriDynamicImportLines = fioriIllustrationsOnFileSystem.map(illustrationName =>
+		`\t\tcase "${illustrationName.replace('.js', '')}": return (await import("../../illustrations/${illustrationName}")).default;`).filter(
+			// skipping the items starting with sapIllus-Dialog, sapIllus-Scene, sapIllus-Spot since they are included in the illustration's js file
+			line => !line.startsWith("\t\tcase \"sapIllus-Dialog") && !line.startsWith("\t\tcase \"sapIllus-Scene") && !line.startsWith("\t\tcase \"sapIllus-Spot") && !line.startsWith("\t\tcase \"AllIllustrations")).join("\n");
+
+	// dynamic imports for Tnt illustrations
+	const tntAvailableIllustrationsArray = `[${tntIllustrationsOnFileSystem.filter(
+		// skipping the items starting with tnt-Dialog, tnt-Scene, tnt-Spot since they are included in the illustration's js file
+		line => !line.startsWith("tnt-Dialog") && !line.startsWith("tnt-Scene") && !line.startsWith("tnt-Spot")).map(illustrationName => `"Tnt${illustrationName.replace('.js', '')}"`).join(", ")}]`;
+
+	const tntDynamicImportLines = tntIllustrationsOnFileSystem.map(illustrationName =>
+		`\t\tcase "Tnt${illustrationName.replace('.js', '')}": return (await import("../../illustrations/tnt/${illustrationName}")).default;`).filter(
+			// skipping the items starting with tnt-Dialog, tnt-Scene, tnt-Spot since they are included in the illustration's js file
+			line => !line.startsWith("\t\tcase \"Tnttnt-Dialog") && !line.startsWith("\t\tcase \"Tnttnt-Scene") && !line.startsWith("\t\tcase \"Tnttnt-Spot")).join("\n");
+
+
+	// dynamic imports file content
+	const contentDynamic = `import { registerIllustrationLoader } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
+
+const loadIllustration = async (illustrationName) => {
+	switch (illustrationName) {
+${fioriDynamicImportLines}
+${tntDynamicImportLines}
+		default: throw new Error("[Illustrations] Illustration not found: " + illustrationName);
+	}
+};
+	const loadAndCheck = async (illustrationName) => {
+		const data = await loadIllustration(illustrationName);
+		return data;
+	}
+
+
+	${fioriAvailableIllustrationsArray}.forEach(illustrationName => registerIllustrationLoader(illustrationName, loadAndCheck));
+	${tntAvailableIllustrationsArray}.forEach(illustrationName => registerIllustrationLoader(illustrationName, loadAndCheck));`;
+	
+
+	await fs.mkdir(path.dirname(outputFile), { recursive: true });
+	return Promise.all([fs.writeFile(outputFile, contentDynamic)]);
+};
+
+generate().then(() => {
+	console.log("Generated Illustrations.js");
+})
+.catch(err => {
+	console.error(err);
+	process.exit(1);
+});

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

@@ -1,37 +1,38 @@
-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 generate = async () => {
 
-const inputFolder = path.normalize(process.argv[2]);
-const outputFile = path.normalize(`${process.argv[3]}/i18n-static.js`);
-const outputFileDynamic = path.normalize(`${process.argv[3]}/i18n.js`);
+	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.js`);
+	const outputFileDynamic = path.normalize(`${process.argv[3]}/i18n.js`);
 
 // 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 contentStatic, contentDynamic;
+	let contentStatic, contentDynamic;
 
 // No i18n - just import dependencies, if any
-if (languages.length === 0) {
-  contentStatic = "";
-  contentDynamic = "";
+	if (languages.length === 0) {
+		contentStatic = "";
+		contentDynamic = "";
 // There is i18n - generate the full file
-} else {
-	// Keys for the array
-	const languagesKeysString = languages.map(key => `"${key}": _${key},`).join("\n\t");
-	const languagesKeysStringArray = languages.map(key => `"${key}",`).join("\n\t");
+	} else {
+		// Keys for the array
+		const languagesKeysString = languages.map(key => `"${key}": _${key},`).join("\n\t");
+		const languagesKeysStringArray = 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");
 
-	// static imports
-	contentStatic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
+		// static imports
+		contentStatic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
 
 ${assetsImportsString}
 
@@ -54,11 +55,11 @@ localeIds.forEach(localeId => {
 });
 `;
 
-	// Actual imports for json assets
-	const dynamicImportsString = languages.map(key => `		case "${key}": return (await import("../assets/i18n/messagebundle_${key}.json")).default;`).join("\n");
+		// Actual imports for json assets
+		const dynamicImportsString = languages.map(key => `		case "${key}": return (await import("../assets/i18n/messagebundle_${key}.json")).default;`).join("\n");
 
-	// Resulting file content
-	contentDynamic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
+		// Resulting file content
+		contentDynamic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
 
 	const importMessageBundle = async (localeId) => {
 		switch (localeId) {
@@ -83,9 +84,15 @@ localeIds.forEach(localeId => {
 	`;
 
 
-}
+	}
 
+	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, contentStatic);
-fs.writeFileSync(outputFileDynamic, contentDynamic);
+generate().then(() => {
+	console.log("Generated i18n JSON imports.");
+});

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

@@ -1,32 +1,32 @@
-const fs = require("fs");
+const fs = require("fs").promises;
 const path = require('path');
-const mkdirp = require("mkdirp");
 const assets = require("../../assets-meta.js");
 
-const inputFolder = path.normalize(process.argv[2]);
-const outputFile = path.normalize(`${process.argv[3]}/Themes-static.js`);
-const outputFileDynamic = path.normalize(`${process.argv[3]}/Themes.js`);
+const generate = async () => {
+	const inputFolder = path.normalize(process.argv[2]);
+	const outputFile = path.normalize(`${process.argv[3]}/Themes-static.js`);
+	const outputFileDynamic = path.normalize(`${process.argv[3]}/Themes.js`);
 
 // All supported optional themes
-const allThemes = assets.themes.all;
+	const allThemes = assets.themes.all;
 
 // All themes present in the file system
-const dirs = fs.readdirSync(inputFolder);
-const themesOnFileSystem = dirs.map(dir => {
-	const matches = dir.match(/sap_.*$/);
-	return matches ? dir : undefined;
-}).filter(key => !!key && allThemes.includes(key));
+	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));
 
-const packageName = JSON.parse(fs.readFileSync("package.json")).name;
+	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("../assets/themes/${theme}/parameters-bundle.css.json")).default;`).join("\n");
+	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("../assets/themes/${theme}/parameters-bundle.css.json")).default;`).join("\n");
 
 
 // static imports file content
-const contentStatic = `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
+	const contentStatic = `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
 
 ${importLines}
 
@@ -39,7 +39,7 @@ const loadThemeProperties = async (themeName) => {
 		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));
@@ -47,14 +47,14 @@ ${availableThemesArray}
 
 
 // dynamic imports file content
-const contentDynamic = `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
+	const contentDynamic = `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
 
 const loadThemeProperties = async (themeName) => {
 	switch (themeName) {
 ${dynamicImportLines}
 		default: throw "unknown theme"
 	}
-}
+};
 
 const loadAndCheck = async (themeName) => {
 	const data = await loadThemeProperties(themeName);
@@ -62,12 +62,19 @@ const loadAndCheck = async (themeName) => {
 		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, contentStatic);
-fs.writeFileSync(outputFileDynamic, contentDynamic);
+	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/src/compiler.js

@@ -12,11 +12,19 @@ const removeWhiteSpaces = (source) => {
 		.replace(/}}\s+{{/g, "}}{{"); // Remove whitespace between }} and {{
 };
 
-const hbs2lit = (file) => {
-	let sPreprocessed = includesReplacer.replace(file);
+const hbs2lit = async (file) => {
+	let sPreprocessed = await includesReplacer.replace(file);
 
 	sPreprocessed = removeWhiteSpaces(sPreprocessed);
 
+	// icons hack
+	if (sPreprocessed.startsWith("<g ") || sPreprocessed.startsWith("<g>")) {
+		return `
+		let block0 = () => {
+			return svg\`${sPreprocessed}\`
+		}`;
+	}
+
 	const ast = Handlebars.parse(sPreprocessed);
 
 	const pv = new PartialsVisitor();
@@ -30,7 +38,16 @@ const hbs2lit = (file) => {
 	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 scopedCode = matches[3];
+			const normalCode = scopedCode.replace(/\${scopeTag\("/g, "").replace(/", tags, suffix\)}/g, "");
+			block = `${matches[1]}${matches[2]}suffix ? ${scopedCode} : ${normalCode};`;
+		}
+
+		result += block + "\n";
 	}
 
 	result = svgProcessor.process(result);

package/lib/hbs2lit/src/includesReplacer.js

@@ -1,9 +1,9 @@
 const path = require("path");
-const fs = require("fs");
+const fs = require("fs").promises;
 
-function replaceIncludes(file) {
+const replaceIncludes = async (file) => {
 	const filePath = path.dirname(file);
-	let fileContent = fs.readFileSync(file, "utf-8");
+	let fileContent = await fs.readFile(file, "utf-8");
 
 	const inclRegex = /{{>\s*include\s*["'](.+?)["']}}/g;
 	let match;
@@ -20,11 +20,11 @@ function replaceIncludes(file) {
 			targetFile = require.resolve(targetFile);
 		}
 
-		fileContent = fileContent.replace(match[0], replaceIncludes(targetFile));
+		fileContent = fileContent.replace(match[0], await replaceIncludes(targetFile));
 	}
 
 	return fileContent;
-}
+};
 
 module.exports = {
 	replace: replaceIncludes

package/lib/hbs2lit/src/litVisitor2.js

@@ -34,7 +34,7 @@ function HTMLLitVisitor(debug) {
 	this.blocks = {};
 	this.result = "";
 	this.mainBlock = "";
-	this.blockPath = "context";
+	this.blockLevel = 0;
 	this.blockParameters = ["context", "tags", "suffix"];
 	this.paths = []; //contains all normalized relative paths
 	this.debug = debug;
@@ -57,7 +57,6 @@ HTMLLitVisitor.prototype.Program = function(program) {
 		this.blocks[this.prevKey()] += this.currentKey() + "(" + this.blockParameters.join(", ") + ")";
 	} else {
 		this.mainBlock = this.currentKey();
-		this.paths.push(this.blockPath);
 	}
 
 	this.blocks[this.currentKey()] += "html`";
@@ -173,7 +172,7 @@ function visitEachBlock(block) {
 
 	this.blocks[this.currentKey()] += "${ repeat(" + normalizePath.call(this, block.params[0].original) + ", (item, index) => item._id || index, (item, index) => ";
 	this.paths.push(normalizePath.call(this, block.params[0].original));
-	this.blockPath = "item";
+	this.blockLevel++;
 
 	if (this.blockParameters.indexOf("item") === -1) {
 		bParamAdded = true;
@@ -185,8 +184,7 @@ function visitEachBlock(block) {
 		this.blockParameters.shift("item");
 		this.blockParameters.shift("index");
 	}
-	this.blockPath = "context";
-
+	this.blockLevel--;
 	this.blocks[this.currentKey()] += ") }";
 }
 
@@ -195,12 +193,52 @@ function normalizePath(sPath) {
 
 	//read carefully - https://github.com/wycats/handlebars.js/issues/1028
 	//kpdecker commented on May 20, 2015
-	if (result.indexOf("../") === 0) {
-		let absolutePath = replaceAll(this.paths[this.paths.length - 1], ".", "/") + "/" + result;
+
+	if (result.indexOf("@root") === 0) {
+		// Trying to access root context via the HBS "@root" variable.
+		// Example: {{@root.property}} compiles to "context.property" - called from anywhere within the template.
+		result = result.replace("@root", "context");
+
+	} else if (result.indexOf("../") === 0) {
+		let absolutePath;
+		const levelsUp = (result.match(/..\//g) || []).length;
+
+		if (this.blockLevel <= levelsUp) {
+			// Trying to access root context from nested loops.
+			// Example: {{../../property}} compiles to "context.property" - when currently in a nested level loop.
+			// Example: {{../../../property}} compile to "context.property" - when requested levels are not present. fallback to root context.
+			absolutePath = `context.${replaceAll(result,"../", "")}`;
+		} else {
+			// Trying to access upper context (one-level-up) and based on the current lelev, that could be "context" or "item".
+			// Example: {{../property}} compiles to "context.property" - when called in a top level loop.
+			// Example: {{../property}} compiles to "item.property" - when called in a nested level loop.
+			// TODO: the second example, although correctly generated to "item.property", "item" will point to the current object within the nested loop,
+			// not the upper level loop as intended. So accessing the upper loop from nested loop is currently not working.
+			absolutePath = replaceAll(this.paths[this.paths.length - 1 - levelsUp], ".", "/") + "/" + result;
+		}
+
 		result = replaceAll(path.normalize(absolutePath), path.sep, ".");
+
 	} else {
-		result = result ? replaceAll(this.blockPath + "/" + result, "/", ".") : this.blockPath;
+		// When neither "@root", nor "../" are used, use the following contexts:
+		// - use "context" - for the top level of execution, e.g "this.blockLevel = 0".
+		// - use "item" - for any nested level, e.g "this.blockLevel > 0".
+		// Example:
+		//
+		// {{text}} -> compiles to "context.text"
+		// {{#each items}}
+				// Item text: {{text}}</div> -> compiles to "item.text"
+				// 	{{#each words}}
+				// 			 Word text: {{text}}</div> -> compiles to "item.text"
+				// 	{{/each}}
+				// 	Item text: {{text}}</div> -> compiles to "item.text"
+		// {{/each}}
+		// {{text}} -> compiles to "context.text"
+
+		const blockPath = this.blockLevel > 0 ? "item" : "context";
+		result = result ? replaceAll(blockPath + "/" + result, "/", ".") : blockPath;
 	}
+
 	return result;
 }
 

package/lib/hbs2ui5/index.js

@@ -1,10 +1,9 @@
-const fs = require('fs');
+const fs = require('fs').promises;
 const getopts = require('getopts');
 const hbs2lit = require('../hbs2lit');
 const path = require('path');
 const litRenderer = require('./RenderTemplates/LitRenderer');
 const recursiveReadDir = require("recursive-readdir");
-const mkdirp = require('mkdirp');
 
 const args = getopts(process.argv.slice(2), {
 	alias: {
@@ -24,13 +23,13 @@ const onError = (place) => {
 
 const isHandlebars = (fileName) => fileName.indexOf('.hbs') !== -1;
 
-const processFile = (file, outputDir) => {
-	const litCode = hbs2lit(file);
+const processFile = async (file, outputDir) => {
+	const litCode = await hbs2lit(file);
 	const absoluteOutputDir = composeAbsoluteOutputDir(file, outputDir);
 	const componentNameMatcher = /(\w+)(\.hbs)/gim;
 	const componentName = componentNameMatcher.exec(file)[1];
 
-	writeRenderers(absoluteOutputDir, componentName, litRenderer.generateTemplate(componentName, litCode));
+	return writeRenderers(absoluteOutputDir, componentName, litRenderer.generateTemplate(componentName, litCode));
 };
 
 const composeAbsoluteOutputDir = (file, outputDir) => {
@@ -40,39 +39,54 @@ const composeAbsoluteOutputDir = (file, outputDir) => {
 	const fileDir = file.split(path.sep).slice(1, -1).join(path.sep);
 
 	// (2) Compose full output dir - "dist/generated/templates/lvl1/lvl2"
-	return `${outputDir}${path.sep}${fileDir}`; 
+	return `${outputDir}${path.sep}${fileDir}`;
 };
 
 const wrapDirectory = (directory, outputDir) => {
 	directory = path.normalize(directory);
 	outputDir = path.normalize(outputDir);
 
-	recursiveReadDir(directory, (err, files) => {
+	return new Promise((resolve, reject) => {
+		recursiveReadDir(directory, (err, files) => {
 
-		if (err) {
-			onError('directory');
-		}
-
-		files.forEach(fileName => {
-			if (isHandlebars(fileName)) {
-				processFile(fileName, outputDir);
+			if (err) {
+				onError('directory');
+				reject();
 			}
+
+			const promises = files.map(fileName => {
+				if (isHandlebars(fileName)) {
+					return processFile(fileName, outputDir);
+				}
+			}).filter(x => !!x);
+
+			resolve(Promise.all(promises));
 		});
-	})
+	});
 };
 
-const writeRenderers = (outputDir, controlName, fileContent) => {
+const writeRenderers = async (outputDir, controlName, fileContent) => {
 	try {
-		if (!fs.existsSync(outputDir)) {
-			mkdirp.sync(outputDir);
-		}
+
+		await fs.mkdir(outputDir, { recursive: true });
 
 		const compiledFilePath = `${outputDir}${path.sep}${controlName}Template.lit.js`;
 
 		// strip DOS line endings because the break the source maps
 		let fileContentUnix = fileContent.replace(/\r\n/g, "\n");
 		fileContentUnix = fileContentUnix.replace(/\r/g, "\n");
-		fs.writeFileSync(compiledFilePath, fileContentUnix);
+
+		// Only write to the file system actual changes - each updated file, no matter if the same or not, triggers an expensive operation for rollup
+		// Note: .hbs files that include a changed .hbs file will also be recompiled as their content will be updated too
+
+		let existingFileContent = "";
+		try {
+			existingFileContent = await fs.readFile(compiledFilePath);
+		} catch (e) {}
+
+		if (existingFileContent !== fileContentUnix) {
+			return fs.writeFile(compiledFilePath, fileContentUnix);
+		}
 
 	} catch (e) {
 		console.log(e);
@@ -82,5 +96,7 @@ const writeRenderers = (outputDir, controlName, fileContent) => {
 if (!args['d'] || !args['o']) {
 	console.log('Please provide an input and output directory (-d and -o)');
 } else {
-	wrapDirectory(args['d'], args['o']);
+	wrapDirectory(args['d'], args['o']).then(() => {
+		console.log("Templates generated");
+	});
 }