@ui5/webcomponents-tools 0.0.0-35e2c9666 → 0.0.0-38861c872

package/lib/create-icons/index.js

@@ -1,72 +1,124 @@
-const fs = require("fs");
-const path = require("path");
-const mkdirp = require("mkdirp");
-
-const collectionName = process.argv[2] || "SAP-icons";
-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/");
-
-mkdirp.sync(destDir);
-
-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 collection = "${collection}";
-const packageName = "${packageName}";
-
-registerIcon(name, { pathData, ltr, collection, packageName });
-
-export default { pathData };`;
-
-
-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 { pathData, accData };`;
-
-
-
-const collectionTemplate = (name) => `import { isThemeFamily } from "@ui5/webcomponents-base/dist/config/Theme.js";
-import pathDataV4 from "./v5/${name}.js";
-import pathDataV5 from "./v4/${name}.js";
-const pathData = isThemeFamily("sap_horizon") ? pathDataV5 : pathDataV4;
-export default { pathData };`;
-
-
-const svgTemplate = (pathData) => `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
-	<path d="${pathData}"/>
-</svg>`;
-
-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 ? iconAccTemplate(name, pathData, ltr, acc, json.collection, json.packageName) : iconTemplate(name, pathData, ltr, json.collection, json.packageName);
-
-		fs.writeFileSync(path.join(destDir, `${name}.js`), content);
-		fs.writeFileSync(path.join(destDir, `${name}.svg`), svgTemplate(pathData));
-
-		if (json.version) {
-			fs.writeFileSync(path.join(path.normalize("dist/"), `${name}.js`), collectionTemplate(name));
-		}
-	}
-};
-
-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

@@ -1,150 +1,165 @@
-const fs = require("fs");
+const fs = require("fs").promises;
 const path = require("path");
-const mkdirp = require("mkdirp");
 
 if (process.argv.length < 7) {
-	return;
+	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 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 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);
+	}
 
-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'));
+	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";
+		const illustrationNameUpperCase = illustrationNameForTranslation.toUpperCase();
+
+		return `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 {
+import spotSvg from "./${illustrationsPrefix}-Spot-${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, {
 	dialogSvg,
 	sceneSvg,
-	spotSvg,
+	spotSvg,${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}";
+	const illustrationTypeDefinition = illustrationName => {
+		return `declare const dialogSvg: string;
+declare const sceneSvg: string;
+declare const spotSvg: string;
+declare const _default: "${illustrationSet === "fiori" ? "" : `${illustrationSet}/`}${illustrationName}";
 
-registerIllustration(name, {
-	dialogSvg,
-	sceneSvg,
-	spotSvg,
-	set,
-});
+export default _default;
+export { dialogSvg, sceneSvg, spotSvg };`
+	};
 
-export {
-	dialogSvg,
-	sceneSvg,
-	spotSvg,
-};`
-};
+	await fs.mkdir(destPath, { recursive: true });
 
-mkdirp.sync(destPath);
+	const illustrationFileNames = await fs.readdir(path.normalize(srcPath));
 
-const illustrationFileNames = fs.readdirSync(path.normalize(srcPath));
+	// convert SVG to JS imports
+	const promises = [];
+	illustrationFileNames.forEach(illustration => {
+		if (fileNamePattern.test(illustration)) {
+			let [fileName, illustrationName] = illustration.match(fileNamePattern);
 
-// convert SVG to JS imports
-illustrationFileNames.forEach(illustration => {
-	if (fileNamePattern.test(illustration)) {
-		let [fileName, illustrationName] = illustration.match(fileNamePattern);
+			promises.push(svgToJs(fileName));
+			fileNames.add(illustrationName);
+		}
+	});
 
-		svgToJs(fileName);
-		fileNames.add(illustrationName);
+	for (let illustrationName of fileNames) {
+		promises.push(fs.writeFile(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName)));
+		promises.push(fs.writeFile(path.join(destPath, `${illustrationName}.d.ts`), illustrationTypeDefinition(illustrationName)));
 	}
-});
 
-for (let illustrationName of fileNames) {
-	fs.writeFileSync(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName));
-}
+	return Promise.all(promises);
+};
+
+generate().then(() => {
+	console.log("Illustrations generated.");
+});