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

package/lib/create-icons/index.js

@@ -1,52 +1,124 @@
-const fs = require("fs");
-const path = require("path");
-const mkdirp = require("mkdirp");
-
-const collectionName = process.argv[2] || "SAP-icons";
-const srcFile = path.normalize(`src/${collectionName}.json`);
-const destDir = path.normalize("dist/");
-
-mkdirp.sync(destDir);
-
-const template = (name, pathData, ltr, collection) => `import { registerIcon } from "@ui5/webcomponents-base/dist/SVGIconRegistry.js";
-
-const name = "${name}";
-const pathData = "${pathData}";
-const ltr = ${ltr};
-const collection = "${collection}";
-
-registerIcon(name, { pathData, ltr, collection});
-
-export default { pathData };`;
-
-
-const accTemplate = (name, pathData, ltr, accData, collection) => `import { registerIcon } from "@ui5/webcomponents-base/dist/SVGIconRegistry.js";
-import { ${accData.key} } from "./generated/i18n/i18n-defaults.js";
-
-const name = "${name}";
-const pathData = "${pathData}";
-const ltr = ${ltr};
-const accData = ${accData.key};
-const collection = "${collection}";
-
-registerIcon(name, { pathData, ltr, accData, collection });
-
-export default { pathData, accData };`;
-
-
-const createIcons = (file) => {
-	const json = JSON.parse(fs.readFileSync(file));
-
-	for (let name in json.data) {
-		const iconData = json.data[name];
-		const pathData = iconData.path;
-		const ltr = !!iconData.ltr;
-		const acc = iconData.acc;
-
-		const content = acc ? accTemplate(name, pathData, ltr, acc, json.collection) : template(name, pathData, ltr, json.collection);
-
-		fs.writeFileSync(path.join(destDir, `${name}.js`), content);
-	}
-};
-
-createIcons(srcFile);
+const fs = require("fs").promises;
+const path = require("path");
+
+const collectionName = process.argv[2] || "SAP-icons-v4";
+const collectionVersion = process.argv[3];
+const srcFile = collectionVersion ? path.normalize(`src/${collectionVersion}/${collectionName}.json`) : path.normalize(`src/${collectionName}.json`);
+const destDir = collectionVersion ? path.normalize(`dist/${collectionVersion}/`) : path.normalize("dist/");
+
+const iconTemplate = (name, pathData, ltr, collection, packageName) => `import { registerIcon } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
+
+const name = "${name}";
+const pathData = "${pathData}";
+const ltr = ${ltr};
+const accData = null;
+const collection = "${collection}";
+const packageName = "${packageName}";
+
+registerIcon(name, { pathData, ltr, collection, packageName });
+
+export default "${collection}/${name}";
+export { pathData, ltr, accData };`;
+
+
+const iconAccTemplate = (name, pathData, ltr, accData, collection, packageName) => `import { registerIcon } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
+import { ${accData.key} } from "../generated/i18n/i18n-defaults.js";
+
+const name = "${name}";
+const pathData = "${pathData}";
+const ltr = ${ltr};
+const accData = ${accData.key};
+const collection = "${collection}";
+const packageName = "${packageName}";
+
+registerIcon(name, { pathData, ltr, accData, collection, packageName });
+
+export default "${collection}/${name}";
+export { pathData, ltr, accData };`;
+
+
+
+const collectionTemplate = (name, versions, fullName) => `import { isLegacyThemeFamily } from "@ui5/webcomponents-base/dist/config/Theme.js";
+import { pathData as pathData${versions[0]}, ltr, accData } from "./${versions[0]}/${name}.js";
+import { pathData as pathData${versions[1]} } from "./${versions[1]}/${name}.js";
+
+const pathData = isLegacyThemeFamily() ? pathData${versions[0]} : pathData${versions[1]};
+
+export default "${fullName}";
+export { pathData, ltr, accData };`;
+
+
+const typeDefinitionTemplate = (name, accData, collection) => `declare const pathData: string;
+declare const ltr: boolean;
+declare const accData: ${accData ? '{ key: string; defaultText: string; }' : null}
+declare const _default: "${collection}/${name}";
+
+export default _default;
+export { pathData, ltr, accData };`
+
+const collectionTypeDefinitionTemplate = (name, accData) => `declare const pathData: string;
+declare const ltr: boolean;
+declare const accData: ${accData ? '{ key: string; defaultText: string; }' : null}
+declare const _default: "${name}";
+
+export default _default;
+export { pathData, ltr, accData };`
+
+
+const svgTemplate = (pathData) => `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
+	<path d="${pathData}"/>
+</svg>`;
+
+const createIcons = async (file) => {
+	await fs.mkdir(destDir, { recursive: true });
+
+	const json = JSON.parse(await fs.readFile(file));
+
+	const promises = [];
+	for (let name in json.data) {
+		const iconData = json.data[name];
+		const pathData = iconData.path;
+		const ltr = !!iconData.ltr;
+		const acc = iconData.acc;
+		const packageName =  json.packageName;
+		const collection =  json.collection;
+
+		const content = acc ? iconAccTemplate(name, pathData, ltr, acc, collection, packageName) : iconTemplate(name, pathData, ltr, collection, packageName);
+
+		promises.push(fs.writeFile(path.join(destDir, `${name}.js`), content));
+		promises.push(fs.writeFile(path.join(destDir, `${name}.svg`), svgTemplate(pathData)));
+		promises.push(fs.writeFile(path.join(destDir, `${name}.d.ts`), typeDefinitionTemplate(name, acc, collection)));
+
+		// For versioned icons collections, the script creates top level (unversioned) module that internally imports the versioned ones.
+		// For example, the top level "@ui5/ui5-webcomponents-icons/dist/accept.js" imports:
+		// - "@ui5/ui5-webcomponents-icons/dist/v5/accept.js" 
+		// - "@ui5/ui5-webcomponents-icons/dist/v4/accept.js"
+
+		if (json.version) {
+			// The exported value from the top level (unversioned) icon module depends on whether the collection is the default,
+			// to add or not the collection name to the exported value:
+			// For the default collection (SAPIcons) we export just the icon name - "export default { 'accept' }"
+			// For non-default collections (SAPTNTIcons and SAPBSIcons) we export the full name - "export default { 'tnt/actor' }"
+			const effectiveName = isDefaultCollection(collection) ? name : getUnversionedFullIconName(name, collection);
+			promises.push(fs.writeFile(path.join(path.normalize("dist/"), `${name}.js`), collectionTemplate(name, json.versions, effectiveName)));
+            promises.push(fs.writeFile(path.join(path.normalize("dist/"), `${name}.d.ts`), collectionTypeDefinitionTemplate(effectiveName, acc)));
+		}
+	}
+
+	return Promise.all(promises);
+};
+
+const isDefaultCollection = collectionName => collectionName === "SAP-icons-v4"  || collectionName === "SAP-icons-v5";
+const getUnversionedFullIconName = (name, collection) => `${getUnversionedCollectionName(collection)}/${name}`;
+const getUnversionedCollectionName = collectionName => CollectionVersionedToUnversionedMap[collectionName] || collectionName;
+
+const CollectionVersionedToUnversionedMap = {
+	"tnt-v2": "tnt",
+	"tnt-v3": "tnt",
+	"business-suite-v1": "business-suite",
+	"business-suite-v2": "business-suite",
+};
+
+createIcons(srcFile).then(() => {
+	console.log("Icons created.");
+});

package/lib/create-illustrations/index.js

@@ -0,0 +1,175 @@
+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 collection = process.argv[7];
+	const fileNamePattern = new RegExp(`${illustrationsPrefix}-.+-(.+).svg`);
+// collect each illustration name because each one should have Sample.js file
+	const fileNames = new Set();
+
+	try {
+		await fs.access(srcPath);
+	} catch (error) {
+		console.log(`The path ${srcPath} does not exist.`);
+		return Promise.resolve(null);
+	}
+
+	console.log(`Generating illustrations from ${srcPath} to ${destPath}`)
+
+	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 collection = "${collection}";
+const title = IM_TITLE_${illustrationNameUpperCase};
+const subtitle = IM_SUBTITLE_${illustrationNameUpperCase};
+
+registerIllustration(name, {
+	dialogSvg,
+	sceneSvg,
+	spotSvg,
+	title,
+	subtitle,
+	set,
+	collection,
+});
+
+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}";
+const collection = "${collection}";
+
+registerIllustration(name, {
+	dialogSvg,
+	sceneSvg,
+	spotSvg,
+	set,
+	collection,
+});
+
+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

@@ -1,80 +1,30 @@
 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 path = require("path");
+const prompts = require("prompts");
+const jsFileContentTemplate = require("./jsFileContentTemplate.js");
+const tsFileContentTemplate = require("./tsFileContentTemplate.js");
 
 /**
- * @public
+ * Hyphanates the given PascalCase string, f.e.:
+ * Foo -> "my-foo" (adds preffix)
+ * FooBar -> "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 result.includes("-") ? result : `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;
-	}
-
-	static get dependencies() {
-		return [];
-	}
-
-	static async onDefine() {
-
-	}
-}
+const capitalizeFirstLetter = string => string.charAt(0).toUpperCase() + string.slice(1);
 
-${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,39 +58,64 @@ const getLibraryName = packageName => {
 	return packageName.substr("webcomponents-".length);
 };
 
-const camelToKebabCase = string => string.replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase();
-
-const packageName = getPackageName();
-const library = getLibraryName(packageName);
-
-const consoleArguments = process.argv.slice(2);
-const componentName = consoleArguments[0];
-
-if (!componentName){
-	console.error("Please enter component name.");
-	return;
+const generateFiles = (componentName, tagName, library, packageName, isTypeScript) => {
+	componentName = capitalizeFirstLetter(componentName);
+	const filePaths = {
+		"main": isTypeScript 
+			? `./src/${componentName}.ts` 
+			: `./src/${componentName}.js`,
+		"css": `./src/themes/${componentName}.css`,
+		"template": `./src/${componentName}.hbs`,
+	};
+
+	const FileContentTemplate = isTypeScript 
+		? tsFileContentTemplate(componentName, tagName, library, packageName) 
+		: jsFileContentTemplate(componentName, tagName, library, packageName);
+
+	fs.writeFileSync(filePaths.main, FileContentTemplate, { flag: "wx+" });
+	fs.writeFileSync(filePaths.css, "", { flag: "wx+" });
+	fs.writeFileSync(filePaths.template, "<div>Hello World</div>", { flag: "wx+" });
+
+	console.log(`Successfully generated ${filePaths.main}`);
+	console.log(`Successfully generated ${filePaths.css}`);
+	console.log(`Successfully generated ${filePaths.template}`);
+
+	// Change the color of the output
+	console.warn('\x1b[33m%s\x1b[0m', `
+	Make sure to import the component in your bundle by using:
+	import "./dist/${componentName}.js";`);
 }
 
-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);
+	const consoleArguments = process.argv.slice(2);
+	let componentName = consoleArguments[0];
 
-fs.writeFileSync(filePaths.js, sJsFileContentTemplate, { flag: "wx+" });
-fs.writeFileSync(filePaths.css, "", { flag: "wx+" });
-fs.writeFileSync(filePaths.hbs, "<div>Hello World</div>", { flag: "wx+" });
+	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.`);
+	}
 
+	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 isTypeScript = fs.existsSync(path.join(process.cwd(), "tsconfig.json"));
+	const tagName = hyphaneteComponentName(componentName);
 
-console.log(`Successfully generated ${componentName}.js`);
-console.log(`Successfully generated ${componentName}.css`);
-console.log(`Successfully generated ${componentName}.hbs`);
+	generateFiles(componentName, tagName, library, packageName, isTypeScript);
+};
 
-// 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";
-`);
+createWebComponent();

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

@@ -0,0 +1,73 @@
+const jsFileContentTemplate = (componentName, tagName, library, packageName) => {
+	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";
+
+/**
+ * @public
+ */
+const metadata = {
+	tag: "${tagName}",
+	properties: /** @lends sap.ui.webc.${library}.${componentName}.prototype */ {
+		//
+	},
+	slots: /** @lends sap.ui.webc.${library}.${componentName}.prototype */ {
+		//
+	},
+	events: /** @lends sap.ui.webc.${library}.${componentName}.prototype */ {
+		//
+	},
+};
+
+/**
+ * @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
+ */
+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;
+	}
+
+	static get dependencies() {
+		return [];
+	}
+}
+
+${componentName}.define();
+
+export default ${componentName};
+`;
+};
+
+module.exports = jsFileContentTemplate;