@ui5/webcomponents-tools 0.0.0-dff5837d7 → 0.0.0-ec448881d

package/lib/create-illustrations/index.js

@@ -0,0 +1,161 @@
+const fs = require("fs").promises;
+const path = require("path");
+
+if (process.argv.length < 7) {
+	throw new Error("Not enough arguments");
+}
+
+const generate = async () => {
+
+	const ORIGINAL_TEXTS = {
+		UnableToLoad: "UnableToLoad",
+		UnableToUpload: "UnableToUpload",
+		NoActivities: "NoActivities",
+		BeforeSearch: "BeforeSearch",
+		NoSearchResults: "NoSearchResults",
+		NoEntries: "NoEntries",
+		NoData: "NoData",
+		NoNotifications: "NoNotifications",
+		BalloonSky: "BalloonSky",
+		SuccessScreen: "SuccessScreen",
+		NoMail: "NoMail",
+		NoSavedItems: "NoSavedItems",
+		NoTasks: "NoTasks"
+	};
+
+	const FALLBACK_TEXTS = {
+		ReloadScreen: ORIGINAL_TEXTS.UnableToLoad,
+		Connection: ORIGINAL_TEXTS.UnableToLoad,
+		ErrorScreen: ORIGINAL_TEXTS.UnableToUpload,
+		EmptyCalendar: ORIGINAL_TEXTS.NoActivities,
+		SearchEarth: ORIGINAL_TEXTS.BeforeSearch,
+		SearchFolder: ORIGINAL_TEXTS.NoSearchResults,
+		EmptyList: ORIGINAL_TEXTS.NoEntries,
+		Tent: ORIGINAL_TEXTS.NoData,
+		SleepingBell: ORIGINAL_TEXTS.NoNotifications,
+		SimpleBalloon: ORIGINAL_TEXTS.BalloonSky,
+		SimpleBell: ORIGINAL_TEXTS.NoNotifications,
+		SimpleCalendar: ORIGINAL_TEXTS.NoActivities,
+		SimpleCheckMark: ORIGINAL_TEXTS.SuccessScreen,
+		SimpleConnection: ORIGINAL_TEXTS.UnableToLoad,
+		SimpleEmptyDoc: ORIGINAL_TEXTS.NoData,
+		SimpleEmptyList: ORIGINAL_TEXTS.NoEntries,
+		SimpleError: ORIGINAL_TEXTS.UnableToUpload,
+		SimpleMagnifier: ORIGINAL_TEXTS.BeforeSearch,
+		SimpleMail: ORIGINAL_TEXTS.NoMail,
+		SimpleNoSavedItems: ORIGINAL_TEXTS.NoSavedItems,
+		SimpleNotFoundMagnifier: ORIGINAL_TEXTS.NoSearchResults,
+		SimpleReload: ORIGINAL_TEXTS.UnableToLoad,
+		SimpleTask: ORIGINAL_TEXTS.NoTasks,
+		SuccessBalloon: ORIGINAL_TEXTS.BalloonSky,
+		SuccessCheckMark: ORIGINAL_TEXTS.SuccessScreen,
+		SuccessHighFive: ORIGINAL_TEXTS.BalloonSky
+	};
+
+	const srcPath = process.argv[2];
+	const defaultText = process.argv[3] === "true";
+	const illustrationsPrefix = process.argv[4];
+	const illustrationSet = process.argv[5];
+	const destPath = process.argv[6];
+	const fileNamePattern = new RegExp(`${illustrationsPrefix}-.+-(.+).svg`);
+// collect each illustration name because each one should have Sample.js file
+	const fileNames = new Set();
+
+	const svgImportTemplate = svgContent => {
+		return `export default \`${svgContent}\`;`
+	};
+	const svgToJs = async fileName => {
+		const svg = await fs.readFile(path.join(srcPath, fileName), {encoding: "utf-8"});
+		const fileContent = svgImportTemplate(svg);
+		fileName = fileName.replace(/\.svg$/, ".js");
+
+		return fs.writeFile(path.join(destPath, fileName), fileContent);
+	};
+	const illustrationImportTemplate = illustrationName => {
+		let illustrationNameForTranslation = illustrationName;
+
+		if (defaultText) {
+			if (FALLBACK_TEXTS[illustrationNameForTranslation]) {
+				illustrationNameForTranslation = FALLBACK_TEXTS[illustrationNameForTranslation];
+			} else if (illustrationName.indexOf("_v") !== -1) {
+				illustrationNameForTranslation = illustrationNameForTranslation.substr(0, illustrationNameForTranslation.indexOf('_v'));
+			}
+		}
+
+		const illustrationNameUpperCase = illustrationNameForTranslation.toUpperCase();
+
+		return defaultText ? `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
+import dialogSvg from "./${illustrationsPrefix}-Dialog-${illustrationName}.js";
+import sceneSvg from "./${illustrationsPrefix}-Scene-${illustrationName}.js";
+import spotSvg from "./${illustrationsPrefix}-Spot-${illustrationName}.js";
+import {
+	IM_TITLE_${illustrationNameUpperCase},
+	IM_SUBTITLE_${illustrationNameUpperCase},
+} from "../generated/i18n/i18n-defaults.js";
+
+const name = "${illustrationName}";
+const set = "${illustrationSet}";
+const title = IM_TITLE_${illustrationNameUpperCase};
+const subtitle = IM_SUBTITLE_${illustrationNameUpperCase};
+
+registerIllustration(name, {
+	dialogSvg,
+	sceneSvg,
+	spotSvg,
+	title,
+	subtitle,
+	set,
+});
+
+export {
+	dialogSvg,
+	sceneSvg,
+	spotSvg,
+};` :
+			`import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
+import dialogSvg from "./${illustrationsPrefix}-Dialog-${illustrationName}.js";
+import sceneSvg from "./${illustrationsPrefix}-Scene-${illustrationName}.js";
+import spotSvg from "./${illustrationsPrefix}-Spot-${illustrationName}.js";
+
+const name = "${illustrationName}";
+const set = "${illustrationSet}";
+
+registerIllustration(name, {
+	dialogSvg,
+	sceneSvg,
+	spotSvg,
+	set,
+});
+
+export {
+	dialogSvg,
+	sceneSvg,
+	spotSvg,
+};`
+	};
+
+	await fs.mkdir(destPath, { recursive: true });
+
+	const illustrationFileNames = await fs.readdir(path.normalize(srcPath));
+
+	// convert SVG to JS imports
+	const promises = [];
+	illustrationFileNames.forEach(illustration => {
+		if (fileNamePattern.test(illustration)) {
+			let [fileName, illustrationName] = illustration.match(fileNamePattern);
+
+			promises.push(svgToJs(fileName));
+			fileNames.add(illustrationName);
+		}
+	});
+
+	for (let illustrationName of fileNames) {
+		promises.push(fs.writeFile(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName)));
+	}
+
+	return Promise.all(promises);
+};
+
+generate().then(() => {
+	console.log("Illustrations generated.");
+});

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

@@ -61,6 +61,10 @@ class ${componentName} extends UI5Element {
 		return ${componentName}Template;
 	}
 
+	static get dependencies() {
+		return [];
+	}
+
 	static async onDefine() {
 
 	}
@@ -135,8 +139,16 @@ console.log(`Successfully generated ${componentName}.js`);
 console.log(`Successfully generated ${componentName}.css`);
 console.log(`Successfully generated ${componentName}.hbs`);
 
+const bundleLogger = fs.createWriteStream("./bundle.common.js", {
+	flags: "a" // appending
+});
+
+bundleLogger.write(`
+// TODO: Move this line in order to keep the file sorted alphabetically
+import ${componentName} from "./dist/${componentName}.js";`);
+
 // Change the color of the output
-console.warn('\x1b[33m%s\x1b[0m', `
-Please import the generated component in bundle.esm.js:
-import ${componentName} from "./dist/${componentName}.js";
-`);
+	console.warn('\x1b[33m%s\x1b[0m', `
+Component is imported in bundle.common.js.
+Do NOT forget to sort the file in alphabeticall order.
+`);

package/lib/documentation/index.js

@@ -7,137 +7,162 @@ const eventsTemplate = require('./templates/api-events-section').template;
 const methodsTemplate = require('./templates/api-methods-section').template;
 const cssVariablesTemplate = require('./templates/api-css-variables-section').template;
 const Handlebars = require('handlebars/dist/handlebars.min.js');
-const fs = require('fs');
+const fs = require('fs').promises;
 const path = require('path');
-const mkdirp = require('mkdirp');
+const beautify = require("json-beautify");
 
-const api = JSON.parse(fs.readFileSync(path.normalize(process.argv[2])));
+const generate = async () => {
 
-const entries = api['symbols'];
-const compiledHandlebars = Handlebars.compile(template);
-const compiledSinceTemplate = Handlebars.compile(sinceTemplate);
-const linkMatcher = /{@link(\s)(\w+)\s*}/gi;
-const sinceMarker = "<!--since_tag_marker-->";
+	const apiJSONPath = path.normalize(process.argv[2]);
+	const api = JSON.parse(await fs.readFile(apiJSONPath));
 
-const getComponentByName = name => {
-	return entries.find(element => {
-		return element.basename === name;
-	})
-};
+	await fs.writeFile(apiJSONPath, beautify(api, null, 2, 100));
 
-const getCSSVarsByName = name => {
-	return cssVariables[name] || [];
-};
+	const entries = api['symbols'];
+	const compiledHandlebars = Handlebars.compile(template);
+	const compiledSinceTemplate = Handlebars.compile(sinceTemplate);
+	const linkMatcher = /{@link(\s)(\w+)\s*}/gi;
+	const sinceMarker = "<!--since_tag_marker-->";
 
-const capitalize = str => {
-	return str.replace(/^./, str => str.toUpperCase());
-};
+	const getComponentByName = name => {
+		return entries.find(element => {
+			return element.basename === name;
+		})
+	};
 
-Handlebars.registerHelper('toLowerCase', function (str) {
-	return str ? str.toLowerCase() : "";
-});
+	const getCSSVarsByName = name => {
+		return cssVariables[name] || [];
+	};
 
-Handlebars.registerHelper('toKebabCase', function (str) {
-	const kebab = str.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
-	return kebab !== str ? kebab : undefined;
-});
+	const capitalize = str => {
+		return str.replace(/^./, str => str.toUpperCase());
+	};
 
-Handlebars.registerHelper('checkEven', function (iIndex) {
-	return (iIndex % 2 === 0) ? "api-table-roll-even" : "api-table-roll-odd";
-});
+	Handlebars.registerHelper('toLowerCase', function (str) {
+		return str ? str.toLowerCase() : "";
+	});
+
+	Handlebars.registerHelper('toKebabCase', function (str) {
+		const kebab = str.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
+		return kebab !== str ? kebab : undefined;
+	});
 
-Handlebars.registerPartial('properties', propertiesTemplate);
-Handlebars.registerPartial('slots', slotsTemplate);
-Handlebars.registerPartial('events', eventsTemplate);
-Handlebars.registerPartial('methods', methodsTemplate);
-Handlebars.registerPartial('cssVariables', cssVariablesTemplate);
+	Handlebars.registerHelper('checkEven', function (iIndex) {
+		return (iIndex % 2 === 0) ? "api-table-roll-even" : "api-table-roll-odd";
+	});
 
-mkdirp.sync(`dist/test-resources/api`);
+	Handlebars.registerPartial('properties', propertiesTemplate);
+	Handlebars.registerPartial('slots', slotsTemplate);
+	Handlebars.registerPartial('events', eventsTemplate);
+	Handlebars.registerPartial('methods', methodsTemplate);
+	Handlebars.registerPartial('cssVariables', cssVariablesTemplate);
 
-let entriesAPI = [];
+	await fs.mkdir(`dist/test-resources/api`, { recursive: true });
 
-const appendCSSVarsAPI = entry => {
-	entry.cssVariables = getCSSVarsByName(entry.basename);
-	return entry;
-}
+	let entriesAPI = [];
 
-const calculateAPI = entry => {
-	if (entriesAPI.indexOf(entry.basename) !== -1) {
+	const appendCSSVarsAPI = entry => {
+		entry.cssVariables = getCSSVarsByName(entry.basename);
 		return entry;
 	}
 
-	let parent = getComponentByName(entry.extends) || {};
-
-	entry = appendCSSVarsAPI(entry);
-	parent = appendCSSVarsAPI(parent);
-
-	parent = { ...{ properties: [], events: [], slots: [], cssVariables: [] }, ...parent };
-
-	// extend component documentation
-	entry.properties = [...(entry.properties || []), ...(parent.properties || [])];
-	entry.events = [...(entry.events || []), ...(parent.events || [])];
-	entry.slots = [...(entry.slots || []), ...(parent.slots || [])];
-	entry.cssVariables = [...(entry.cssVariables || []), ...(parent.cssVariables || [])];
+	const componentHasEntityItem = (component, entity, name) => {
+		return component[entity].some(x => x && x.name === name);
+	};
+	const removeEmpty = arr => arr.filter(x => x);
 
-	entriesAPI.push(entry.basename);
+	const calculateAPI = component => {
+		if (entriesAPI.indexOf(component.basename) !== -1) {
+			return component;
+		}
+		const entities = ["properties", "slots", "events", "methods", "cssVariables"];
 
-	return entry;
-}
+		// Initialize all entities with [] if necessary, and remove undefined things, and only leave public things
+		entities.forEach(entity => {
+			component[entity] = removeEmpty(component[entity] || []).filter(x => x.visibility === "public");
+		});
 
-const appendAdditionalEntriesAPI = entry => {
-	if (entry.appenddocs) {
-		const additionalEntries = entry.appenddocs.split(" ");
-		entry.additionalDocs = [];
+		component = appendCSSVarsAPI(component);
+
+		let parent = getComponentByName(component.extends);
+		if (parent) {
+			let parentComponent = calculateAPI(parent);
+			entities.forEach(entity => {
+				parentComponent[entity].forEach(x => {
+					if (!componentHasEntityItem(component, entity, x.name)) {
+						component[entity].push(x);
+					}
+				});
+			});
+		}
+
+		entriesAPI.push(component.basename);
+
+		return component;
+	};
+
+	const appendAdditionalEntriesAPI = entry => {
+		if (entry.appenddocs) {
+			const additionalEntries = entry.appenddocs.split(" ");
+			entry.additionalDocs = [];
+
+			additionalEntries.forEach(entryName => {
+				let additionalEntry = getComponentByName(entryName);
+				additionalEntry = calculateAPI(additionalEntry);
+				entry.additionalDocs.push(additionalEntry);
+			});
+		}
 
-		additionalEntries.forEach(entryName => {
-			let additionalEntry = getComponentByName(entryName);
-			additionalEntry = calculateAPI(additionalEntry);
-			entry.additionalDocs.push(additionalEntry);
-		});
+		return entry;
 	}
 
-	return entry;
-}
+	const generateSamplePage = async entry => {
+		let content = "";
 
-const generateSamplePage = entry => {
-	let content = "";
+		try {
+			content = await fs.readFile(`dist/test-resources/samples/${capitalize(entry.basename)}.sample.html`, 'utf8');
+		} catch (err) {
+		}
 
-	try {
-		content = fs.readFileSync(`dist/test-resources/samples/${capitalize(entry.basename)}.sample.html`, 'utf8');
-	} catch (err) { }
+		if (content) {
+			entry.slots.forEach(slotData => {
+				if (!slotData.type.startsWith("Node") && !slotData.type.startsWith("HTMLElement")) { // interface -> don't show in documentation
+					slotData.type = "HTMLElement" + (slotData.type.endsWith("[]") ? "[]" : "");
+				}
+			});
+			const APIReference = compiledHandlebars(entry).replace(/\[\]/g, " [0..n]");
+			const EntitySince = compiledSinceTemplate(entry).replace(/\[\]/g, " [0..n]");
 
-	if (content) {
-		const APIReference = compiledHandlebars(entry).replace(/\[\]/g, " [0..n]");
-		const EntitySince = compiledSinceTemplate(entry).replace(/\[\]/g, " [0..n]");
+			content = content.replace('<!-- JSDoc marker -->', APIReference);
+			content = content.replace(sinceMarker, EntitySince);
 
-		content = content.replace('<!-- JSDoc marker -->', APIReference);
-		content = content.replace(sinceMarker, EntitySince);
+			content = content.replace(linkMatcher, match => {
+				const component = linkMatcher.exec(match)[2];
 
-		content = content.replace(linkMatcher, match => {
-			const component = linkMatcher.exec(match)[2];
+				// reset the regex
+				linkMatcher.lastIndex = 0;
 
-			// reset the regex
-			linkMatcher.lastIndex = 0;
-
-			return `<a href="#" onclick="redirect(event, '${component}')">${component}</a>`;
-		});
+				return `<a href="#" onclick="redirect(event, '${component}')">${component}</a>`;
+			});
 
-		fs.writeFile(`dist/test-resources/api/${entry.basename}.sample.html`, content, (err) => {
-			// console.log(err);
-		});
+			return fs.writeFile(`dist/test-resources/api/${entry.basename}.sample.html`, content);
+		}
 	}
-}
 
-const generateComponentAPI = entry => {
-	// (1) calculate the API
-	entry = calculateAPI(entry);
+	const generateComponentAPI = entry => {
+		// (1) calculate the API
+		entry = calculateAPI(entry);
 
-	// (2) append additional API for composition components - List -> ListIems, TabContainer -> Tabs, Table -> TableRow/Column/Cell
-	entry = appendAdditionalEntriesAPI(entry);
+		// (2) append additional API for composition components - List -> ListIems, TabContainer -> Tabs, Table -> TableRow/Column/Cell
+		entry = appendAdditionalEntriesAPI(entry);
 
-	// (3) generate sample page
-	generateSamplePage(entry);
-}
+		// (3) generate sample page
+		return generateSamplePage(entry);
+	}
 
-entries.forEach(generateComponentAPI);
-entriesAPI = [];
+	return Promise.all(entries.map(generateComponentAPI));
+};
+
+generate().then(() => {
+	console.log("Documentation generated.");
+});

package/lib/documentation/templates/api-properties-section.js

@@ -21,7 +21,9 @@ module.exports = {
               {{/if}}
                 <br>
               {{#if (toKebabCase this.name)}}
-                <code>{{toKebabCase this.name}}</code>
+                  {{#unless this.noattribute}}
+                     <code>{{toKebabCase this.name}}</code>
+                 {{/unless}}
               {{/if}}
             </div>
             <div class="cell api-table-content-cell">{{this.type}}</div>

package/lib/documentation/templates/template.js

@@ -23,6 +23,7 @@ module.exports = {
             {{> properties this}}
             {{> slots this}}
             {{> events this}}
+            {{> methods this}}
             {{> cssVariables this}} 
           </section>
         </section>
@@ -33,6 +34,6 @@ module.exports = {
         <a class="separator" href="https://www.sap.com/about/legal/privacy.html" target="_blank">Privacy Policy</a>
         <a href="https://www.sap.com/about/legal/impressum.html" target="_blank">Legal</a>
       </div>
-      <img src="../../../../../../assets/images/sap-logo-svg.svg" alt="Sap Logo" />
+      <img src="../../../assets/images/sap-logo-svg.svg" alt="Sap Logo" />
     </footer>`
 };

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 + "**/*.js");
+	return Promise.all(fileNames.map(convertImports).filter(x => !!x));
+};
+
+generate().then(() => {
+	console.log("Success: Converted absolute imports to relative for files in:", basePath);
+});