@ui5/webcomponents-tools 0.0.0-deac3098a → 0.0.0-df5b4199a

package/lib/create-illustrations/index.js

@@ -1,150 +1,205 @@
-const fs = require("fs");
+const fs = require("fs").promises;
 const path = require("path");
-const mkdirp = require("mkdirp");
+const { scopeThemingVariables } = require("../css-processors/scope-variables.mjs");
 
-if (process.argv.length < 7) {
-	return;
-}
+const generate = async (argv) => {
+	if (argv.length < 7) {
+		throw new Error("Not enough arguments");
+	}
 
-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 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",
+		NoDimensionsSet: "NoDimensionsSet",
+		AddPeople: "AddPeople",
+		AddColumn: "AddColumn",
+		SortColumn: "SortColumn",
+		FilterTable: "FilterTable",
+		ResizeColumn: "ResizeColumn",
+		GroupTable: "GroupTable",
+		UploadCollection: "UploadCollection"
+	};
+
+	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,
+		NoChartData: ORIGINAL_TEXTS.NoDimensionsSet,
+		AddingColumns: ORIGINAL_TEXTS.AddColumn,
+		SortingColumns: ORIGINAL_TEXTS.SortColumn,
+		FilteringColumns: ORIGINAL_TEXTS.FilterTable,
+		ResizingColumns: ORIGINAL_TEXTS.ResizeColumn,
+		GroupingColumns: ORIGINAL_TEXTS.GroupTable,
+		AddPeopleToCalendar: ORIGINAL_TEXTS.AddPeople,
+		DragFilesToUpload: ORIGINAL_TEXTS.UploadCollection,
+		KeyTask: ORIGINAL_TEXTS.SuccessScreen,
+		ReceiveAppreciation: ORIGINAL_TEXTS.BalloonSky,
+		SuccessBalloon: ORIGINAL_TEXTS.BalloonSky,
+		SuccessCheckMark: ORIGINAL_TEXTS.SuccessScreen,
+		SuccessHighFive: ORIGINAL_TEXTS.BalloonSky
+	};
+
+	const srcPath = argv[2];
+	const defaultText = argv[3] === "true";
+	const illustrationsPrefix = argv[4];
+	const illustrationSet = argv[5];
+	const destPath = argv[6];
+	const collection = argv[7];
+	const fileNamePattern = new RegExp(`${illustrationsPrefix}-.+-(.+).svg`);
+	// collect each illustration name because each one should have Sample.js file
+	const fileNames = new Set();
+
+	let dotIllustrationNames = [];
+
+	try {
+		await fs.access(srcPath);
+	} catch (error) {
+		console.log(`The path ${srcPath} does not exist.`);
+		return Promise.resolve(null);
+	}
 
-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
-};
+	console.log(`Generating illustrations from ${srcPath} to ${destPath}`)
 
-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 = fileName => {
-	const svg = fs.readFileSync(path.join(srcPath, fileName), { encoding: "utf-8" });
-	const fileContent = svgImportTemplate(svg);
-	fileName = fileName.replace(/\.svg$/, ".js");
-
-	fs.writeFileSync(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 svgImportTemplate = svgContent => {
+		return `export default \`${scopeThemingVariables(svgContent)}\`;`
+	};
+	const svgToJs = async fileName => {
+		const svg = await fs.readFile(path.join(srcPath, fileName), { encoding: "utf-8" });
+		const fileContent = svgImportTemplate(svg);
+		const fileNameSplitArr = fileName.split('-');
+		fileName = fileName.replace(/\.svg$/, ".js");
+
+		if (fileNameSplitArr[1] === 'Dot') {
+			// we keep the Dot illustration names to import them later. If no Dot is present, Spot will be used
+			dotIllustrationNames.push(fileNameSplitArr[2].split('.')[0]);
 		}
-	}
 
-	const illustrationNameUpperCase = illustrationNameForTranslation.toUpperCase();
-	
-	return defaultText ? `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.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();
+		// If no Dot is present, Spot will be imported as Dot
+		const hasDot = dotIllustrationNames.indexOf(illustrationName) !== -1 ? 'Dot' : 'Spot';
+
+		return `import { unsafeRegisterIllustration } 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 {
+import dotSvg from "./${illustrationsPrefix}-${hasDot}-${illustrationName}.js";${defaultText ? `import {
 	IM_TITLE_${illustrationNameUpperCase},
 	IM_SUBTITLE_${illustrationNameUpperCase},
-} from "../generated/i18n/i18n-defaults.js";
+} from "../generated/i18n/i18n-defaults.js";` : ``}
 
 const name = "${illustrationName}";
 const set = "${illustrationSet}";
+const collection = "${collection}";${defaultText ? `
 const title = IM_TITLE_${illustrationNameUpperCase};
-const subtitle = IM_SUBTITLE_${illustrationNameUpperCase};
+const subtitle = IM_SUBTITLE_${illustrationNameUpperCase};` : ``}
 
-registerIllustration(name, {
+unsafeRegisterIllustration(name, {
 	dialogSvg,
 	sceneSvg,
 	spotSvg,
+	dotSvg,${defaultText ? `
 	title,
-	subtitle,
+	subtitle,` : ``}
 	set,
+	collection,
 });
 
+export default "${illustrationSet === "fiori" ? "" : `${illustrationSet}/`}${illustrationName}";
 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}";
+	dotSvg,
+};`
+	};
 
-registerIllustration(name, {
-	dialogSvg,
-	sceneSvg,
-	spotSvg,
-	set,
-});
+	const illustrationTypeDefinition = illustrationName => {
+		return `declare const dialogSvg: string;
+declare const sceneSvg: string;
+declare const spotSvg: string;
+declare const dotSvg: string;
+declare const _default: "${illustrationSet === "fiori" ? "" : `${illustrationSet}/`}${illustrationName}";
 
-export {
-	dialogSvg,
-	sceneSvg,
-	spotSvg,
-};`
-};
+export default _default;
+export { dialogSvg, sceneSvg, spotSvg, dotSvg };`
+	};
 
-mkdirp.sync(destPath);
+	await fs.mkdir(destPath, { recursive: true });
 
-const illustrationFileNames = fs.readdirSync(path.normalize(srcPath));
+	const illustrationFileNames = await fs.readdir(path.normalize(srcPath));
 
-// convert SVG to JS imports
-illustrationFileNames.forEach(illustration => {
-	if (fileNamePattern.test(illustration)) {
-		let [fileName, illustrationName] = illustration.match(fileNamePattern);
+	// convert SVG to JS imports
+	const promises = [];
+	illustrationFileNames.forEach(illustration => {
+		if (fileNamePattern.test(illustration)) {
+			let [fileName, illustrationName] = illustration.match(fileNamePattern);
 
-		svgToJs(fileName);
-		fileNames.add(illustrationName);
-	}
-});
+			promises.push(svgToJs(fileName));
+			fileNames.add(illustrationName);
+		}
+	});
+
+	return Promise.all(promises)
+		.then(() => {
+			const nestedPromises = [];
+			for (let illustrationName of fileNames) {
+				nestedPromises.push(fs.writeFile(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName)));
+				nestedPromises.push(fs.writeFile(path.join(destPath, `${illustrationName}.d.ts`), illustrationTypeDefinition(illustrationName)));
+			}
+
+			return Promise.all(nestedPromises);
+		})
+		.then(() => {
+			console.log("Illustrations generated.");
+		});
+};
 
-for (let illustrationName of fileNames) {
-	fs.writeFileSync(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName));
+if (require.main === module) {
+	generate(process.argv)
 }
+
+exports._ui5mainFn = generate;

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

@@ -0,0 +1,74 @@
+const Component = (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-strict.js";
+import jsxRenderer from "@ui5/webcomponents-base/dist/renderer/JsxRenderer.js";
+
+import ${componentName}Template from "./${componentName}Template.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
+ * @extends UI5Element
+ * @public
+ */
+@customElement({
+	tag: "${tagName}",
+	renderer: jsxRenderer,
+	styles: ${componentName}Css,
+	template: ${componentName}Template,
+})
+
+/**
+ * Example custom event.
+ * Please keep in mind that all public events should be documented in the API Reference as shown below.
+ *
+ * @public
+ */
+@event("interact")
+class ${componentName} extends UI5Element {
+	eventDetails!: {
+		"interact": void,
+	};
+
+	/**
+	 * Defines the value of the component.
+	 *
+	 * @default ""
+	 * @public
+	 */
+	@property()
+	value?: string;
+
+	/**
+	 * Defines the text of the component.
+	 *
+	 * @public
+	 */
+	@slot({ type: Node, "default": true })
+	text!: Array<Node>;
+}
+
+${componentName}.define();
+
+export default ${componentName};
+`;
+};
+
+module.exports = Component;

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

@@ -0,0 +1,12 @@
+const ComponentTemplate = (componentName) => {
+	return `import type ${componentName} from "./${componentName}.js";
+
+export default function ${componentName}Template(this: ${componentName}) {
+	return (
+		<div>Hello World!</div>
+	);
+}
+`;
+};
+
+module.exports = ComponentTemplate;

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

@@ -1,80 +1,31 @@
 const fs = require("fs");
-
-const jsFileContentTemplate = componentName => {
-	return `import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.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";
+const prompts = require("prompts");
+const Component = require("./Component.js");
+const ComponentTemplate= require("./ComponentTemplate.js");
+const dotenv = require('dotenv');
+dotenv.config();
 
 /**
- * @public
+ * Hyphanates the given PascalCase string and adds prefix, f.e.:
+ * Foo -> "my-foo"
+ * FooBar -> "my-foo-bar"
  */
-const metadata = {
-	tag: "${tagName}",
-	properties: /** @lends sap.ui.webcomponents.${library}.${componentName}.prototype */ {
-		//
-	},
-	slots: /** @lends sap.ui.webcomponents.${library}.${componentName}.prototype */ {
-		//
-	},
-	events: /** @lends sap.ui.webcomponents.${library}.${componentName}.prototype */ {
-		//
-	},
+const hyphaneteComponentName = (componentName) => {
+	const result = componentName.replace(/([a-z])([A-Z])/g, '$1-$2' ).toLowerCase();
+
+	return `${process.env.UI5_TAG_NAME_PREFIX ?? "my"}-${result}`;
 };
 
 /**
- * @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.webcomponents.${library}.${componentName}
- * @extends UI5Element
- * @tagname ${tagName}
- * @public
+ * Capitalizes first letter of string.
  */
-class ${componentName} extends UI5Element {
-	static get metadata() {
-		return metadata;
-	}
-
-	static get render() {
-		return litRender;
-	}
-
-	static get styles() {
-		return ${componentName}Css;
-	}
-
-	static get template() {
-		return ${componentName}Template;
-	}
+const capitalizeFirstLetter = string => string.charAt(0).toUpperCase() + string.slice(1);
 
-	static get dependencies() {
-		return [];
-	}
-
-	static async onDefine() {
-
-	}
-}
-
-${componentName}.define();
-
-export default ${componentName};
-`;
-};
+/**
+ * Validates component name, enforcing PascalCase pattern - Button, MyButton.
+ */
+const PascalCasePattern = /^[A-Z][A-Za-z0-9]+$/;
+const isNameValid = name => typeof name === "string" && PascalCasePattern.test(name);
 
 const getPackageName = () => {
 	if (!fs.existsSync("./package.json")) {
@@ -108,47 +59,57 @@ const getLibraryName = packageName => {
 	return packageName.substr("webcomponents-".length);
 };
 
-const camelToKebabCase = string => string.replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase();
+const generateFiles = (componentName, tagName, library, packageName) => {
+	componentName = capitalizeFirstLetter(componentName);
+	const filePaths = {
+		"main": `./src/${componentName}.ts`,
+		"css": `./src/themes/${componentName}.css`,
+		"template": `./src/${componentName}${process.env.UI5_TEMPLATE_FILENAME_SUFFIX ?? "Template"}.tsx`,
+	};
 
-const packageName = getPackageName();
-const library = getLibraryName(packageName);
+	fs.writeFileSync(filePaths.main, Component(componentName, tagName, library, packageName), { flag: "wx+" });
+	fs.writeFileSync(filePaths.css, "", { flag: "wx+" });
+	fs.writeFileSync(filePaths.template, ComponentTemplate(componentName), { flag: "wx+" });
 
-const consoleArguments = process.argv.slice(2);
-const componentName = consoleArguments[0];
+	console.log(`Successfully generated ${filePaths.main}`);
+	console.log(`Successfully generated ${filePaths.css}`);
+	console.log(`Successfully generated ${filePaths.template}`);
 
-if (!componentName){
-	console.error("Please enter component name.");
-	return;
+	// Change the color of the output
+	console.warn('\x1b[33m%s\x1b[0m', `
+Now, import the component in "src/bundle.esm.ts" via: import "./${componentName}.js";
+And, add it to your HTML: <${tagName}></${tagName}>.`);
 }
 
-const tagName = `ui5-${camelToKebabCase(componentName)}`;
+// Main function
+const createWebComponent = async () => {
+	const packageName = getPackageName();
+	const library = getLibraryName(packageName);
 
-const filePaths = {
-	"js": `./src/${componentName}.js`,
-	"css": `./src/themes/${componentName}.css`,
-	"hbs": `./src/${componentName}.hbs`,
-};
-const sJsFileContentTemplate = jsFileContentTemplate(componentName);
-
-fs.writeFileSync(filePaths.js, sJsFileContentTemplate, { flag: "wx+" });
-fs.writeFileSync(filePaths.css, "", { flag: "wx+" });
-fs.writeFileSync(filePaths.hbs, "<div>Hello World</div>", { flag: "wx+" });
+	const consoleArguments = process.argv.slice(2);
+	let componentName = consoleArguments[0];
 
+	if (componentName && !isNameValid(componentName)) {
+		throw new Error(`${componentName} is invalid component name. Use only letters (at least two) and start with capital one:  Button, MyButton, etc.`);
+	}
 
-console.log(`Successfully generated ${componentName}.js`);
-console.log(`Successfully generated ${componentName}.css`);
-console.log(`Successfully generated ${componentName}.hbs`);
+	if (!componentName) {
+		const response = await prompts({
+			type: "text",
+			name: "componentName",
+			message: "Please enter a component name:",
+			validate: (value) => isNameValid(value) ? true : "Component name should follow PascalCase naming convention (f.e. Button, MyButton, etc.).",
+		});
+		componentName = response.componentName;
+
+		if (!componentName) {
+			process.exit();
+		}
+	}
 
-const bundleLogger = fs.createWriteStream("./bundle.common.js", {
-	flags: "a" // appending
-});
+	const tagName = hyphaneteComponentName(componentName);
 
-bundleLogger.write(`
-// TODO: Move this line in order to keep the file sorted alphabetically
-import ${componentName} from "./dist/${componentName}.js";`);
+	generateFiles(componentName, tagName, library, packageName);
+};
 
-// Change the color of the output
-	console.warn('\x1b[33m%s\x1b[0m', `
-Component is imported in bundle.common.js.
-Do NOT forget to sort the file in alphabeticall order.
-`);
+createWebComponent();