@ui5/webcomponents-tools 0.0.0-c0e494b02 → 0.0.0-c143e338b

package/lib/copy-and-watch/index.js

@@ -30,116 +30,124 @@ const globParent = require('glob-parent');
 
 /* CODE */
 
-const args = process.argv.slice(2);
-const options = {};
-
-['watch', 'clean', 'skip-initial-copy', 'safe',  'silent'].forEach(key => {
-	const index = args.indexOf(`--${key}`);
-	if (index >= 0) {
-		options[key] = true;
-		args.splice(index, 1);
+const copyAndWatchFn = async (argv) => {
+	const args = argv.slice(2);
+	const options = {};
+
+	['watch', 'clean', 'skip-initial-copy', 'safe', 'silent'].forEach(key => {
+		const index = args.indexOf(`--${key}`);
+		if (index >= 0) {
+			options[key] = true;
+			args.splice(index, 1);
+		}
+	});
+
+	if (args.length < 2) {
+		console.error('Not enough arguments: copy-and-watch [options] <sources> <target>');
+		process.exit(1);
 	}
-});
 
-if (args.length < 2) {
-	console.error('Not enough arguments: copy-and-watch [options] <sources> <target>'.red);
-	process.exit(1);
-}
+	if (options['skip-initial-copy'] && !options['watch']) {
+		console.error('--skip-initial-copy argument is meant to be used with --watch, otherwise no files will be copied');
+		process.exit(1);
+	}
 
-if (options['skip-initial-copy'] && !options['watch']) {
-	console.error('--skip-initial-copy argument is meant to be used with --watch, otherwise no files will be copied'.red);
-	process.exit(1);
-}
+	const target = args.pop();
+	const sources = args;
+	const parents = [...new Set(sources.map(globParent))];
 
-const target = args.pop();
-const sources = args;
-const parents = [...new Set(sources.map(globParent))];
-
-const findTarget = from => {
-	const parent = parents
-		.filter(p => from.indexOf(p) >= 0)
-		.sort()
-		.reverse()[0];
-	return path.join(target, path.relative(parent, from));
-};
-const createDirIfNotExist = to => {
-	'use strict';
-
-	const dirs = [];
-	let dir = path.dirname(to);
-
-	while (dir !== path.dirname(dir)) {
-		dirs.unshift(dir);
-		dir = path.dirname(dir);
-	}
+	const findTarget = from => {
+		const parent = parents
+			.filter(p => from.indexOf(p) >= 0)
+			.sort()
+			.reverse()[0];
+		return path.join(target, path.relative(parent, from));
+	};
+	const createDirIfNotExist = to => {
+		'use strict';
+
+		const dirs = [];
+		let dir = path.dirname(to);
 
-	dirs.forEach(dir => {
-		if (!fs.existsSync(dir)) {
-			fs.mkdirSync(dir);
+		while (dir !== path.dirname(dir)) {
+			dirs.unshift(dir);
+			dir = path.dirname(dir);
 		}
-	});
-};
-const copy = from => {
-	const to = findTarget(from);
-	createDirIfNotExist(to);
-	const stats = fs.statSync(from);
-	if (stats.isDirectory()) {
-		return;
-	}
-	fs.writeFileSync(to, fs.readFileSync(from));
-	options.silent || console.log('[COPY]'.yellow, from, 'to'.yellow, to);
-};
-const remove = from => {
-	const to = findTarget(from);
-	fs.unlinkSync(to);
-	options.silent || console.log('[DELETE]'.yellow, to);
-};
-const rimraf = dir => {
-	if (fs.existsSync(dir)) {
-		fs.readdirSync(dir).forEach(entry => {
-			const entryPath = path.join(dir, entry);
-			if (fs.lstatSync(entryPath).isDirectory()) {
-				rimraf(entryPath);
-			} else {
-				fs.unlinkSync(entryPath);
+
+		dirs.forEach(dir => {
+			if (!fs.existsSync(dir)) {
+				fs.mkdirSync(dir);
 			}
 		});
-		fs.rmdirSync(dir);
+	};
+	const copy = from => {
+		const to = findTarget(from);
+		createDirIfNotExist(to);
+		const stats = fs.statSync(from);
+		if (stats.isDirectory()) {
+			return;
+		}
+		fs.writeFileSync(to, fs.readFileSync(from));
+		options.silent || console.log('[COPY]', from, 'to', to);
+	};
+	const remove = from => {
+		const to = findTarget(from);
+		fs.unlinkSync(to);
+		options.silent || console.log('[DELETE]', to);
+	};
+	const rimraf = dir => {
+		if (fs.existsSync(dir)) {
+			fs.readdirSync(dir).forEach(entry => {
+				const entryPath = path.join(dir, entry);
+				if (fs.lstatSync(entryPath).isDirectory()) {
+					rimraf(entryPath);
+				} else {
+					fs.unlinkSync(entryPath);
+				}
+			});
+			fs.rmdirSync(dir);
+		}
+	};
+
+	// clean
+	if (options.clean) {
+		rimraf(target);
 	}
-};
 
-// clean
-if (options.clean) {
-	rimraf(target);
-}
+	// initial copy
+	if (!options['skip-initial-copy']) {
+		sources.forEach(s => glob.sync(s).forEach(copy));
+	}
 
-// initial copy
-if (!options['skip-initial-copy']) {
-	sources.forEach(s => glob.sync(s).forEach(copy));
-}
+	// watch
+	if (options.watch) {
+		const chokidarOptions = {
+			ignoreInitial: true
+		};
 
-// watch
-if (options.watch) {
-	const chokidarOptions = {
-		ignoreInitial: true
-	};
+		if (options.safe) {
+			chokidarOptions.awaitWriteFinish = {
+				stabilityThreshold: 500,
+				pollInterval: 100
+			};
+		}
 
-	if (options.safe) {
-		chokidarOptions.awaitWriteFinish = {
-			stabilityThreshold: 500,
-			pollInterval: 100
-		};
+		chokidar
+			.watch(sources, chokidarOptions)
+			.on('ready', () => sources.forEach(s => {
+				options.silent || console.log('[WATCH]', s);
+			}))
+			.on('add', copy)
+			.on('addDir', copy)
+			.on('change', copy)
+			.on('unlink', remove)
+			.on('unlinkDir', remove)
+			.on('error', e => console.log('[ERROR]', e));
 	}
+}
 
-	chokidar
-		.watch(sources, chokidarOptions)
-		.on('ready', () => sources.forEach(s => {
-			options.silent || console.log('[WATCH]'.yellow, s);
-		}))
-		.on('add', copy)
-		.on('addDir', copy)
-		.on('change', copy)
-		.on('unlink', remove)
-		.on('unlinkDir', remove)
-		.on('error', e => console.log('[ERROR]'.red, e));
+if (require.main === module) {
+	copyAndWatchFn(process.argv)
 }
+
+exports._ui5mainFn = copyAndWatchFn;

package/lib/copy-list/index.js

@@ -1,11 +1,10 @@
 const fs = require("fs").promises;
 const path = require("path");
 
-const fileList = process.argv[2];
-const dest = process.argv[3];
-const src = "@openui5/sap.ui.core/src/";
-
-const generate = async () => {
+const generate = async (argv) => {
+	const fileList = argv[2];
+	const dest = argv[3];
+	const src = "@openui5/sap.ui.core/src/";
 	const filesToCopy = (await fs.readFile(fileList)).toString();
 	// console.log(filesToCopy);
 
@@ -14,15 +13,22 @@ const generate = async () => {
 
 	const trimFile = file => file.trim();
 
-	return filesToCopy.split("\n").map(trimFile).filter(shouldCopy).map(async moduleName => {
-		const srcPath = require.resolve(path.join(src, moduleName), {paths: [process.cwd()]});
+	const promises = filesToCopy.split("\n").map(trimFile).filter(shouldCopy).map(async moduleName => {
+		const srcPath = require.resolve(path.join(src, moduleName), { paths: [process.cwd()] });
 		const destPath = path.join(dest, moduleName);
 
 		await fs.mkdir(path.dirname(destPath), { recursive: true });
 		return fs.copyFile(srcPath, destPath);
 	});
+
+	return Promise.all(promises).then(() => {
+		console.log("Files copied.");
+	});
 };
 
-generate().then(() => {
-	console.log("Files copied.");
-});
+
+if (require.main === module) {
+	generate(process.argv)
+}
+
+exports._ui5mainFn = generate;

package/lib/create-icons/index.js

@@ -1,11 +1,6 @@
 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}";
@@ -21,8 +16,8 @@ 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 iconAccTemplate = (name, pathData, ltr, accData, collection, packageName, versioned) => `import { registerIcon } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
+import { ${accData.key} } from "${versioned ? "../" : "./"}generated/i18n/i18n-defaults.js";
 
 const name = "${name}";
 const pathData = "${pathData}";
@@ -38,14 +33,16 @@ export { pathData, ltr, accData };`;
 
 
 
-const collectionTemplate = (name, versions, fullName) => `import { isLegacyThemeFamily } from "@ui5/webcomponents-base/dist/config/Theme.js";
+const collectionTemplate = (name, versions, fullName) => `import { isLegacyThemeFamilyAsync } 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]};
+const getPathData = async() => {
+	return await isLegacyThemeFamilyAsync() ? pathDatav4 : pathDatav5;
+};
 
 export default "${fullName}";
-export { pathData, ltr, accData };`;
+export { getPathData, ltr, accData };`;
 
 
 const typeDefinitionTemplate = (name, accData, collection) => `declare const pathData: string;
@@ -56,23 +53,27 @@ declare const _default: "${collection}/${name}";
 export default _default;
 export { pathData, ltr, accData };`
 
-const collectionTypeDefinitionTemplate = (name, accData) => `declare const pathData: string;
+const collectionTypeDefinitionTemplate = (name, accData) => `declare const getPathData: () => Promise<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 };`
+export { getPathData, 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) => {
+const createIcons = async (argv) => {
+	const collectionName = argv[2] || "SAP-icons-v4";
+	const collectionVersion = 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/");
 	await fs.mkdir(destDir, { recursive: true });
 
-	const json = JSON.parse(await fs.readFile(file));
+	const json = JSON.parse(await fs.readFile(srcFile));
 
 	const promises = [];
 	for (let name in json.data) {
@@ -80,10 +81,11 @@ const createIcons = async (file) => {
 		const pathData = iconData.path;
 		const ltr = !!iconData.ltr;
 		const acc = iconData.acc;
-		const packageName =  json.packageName;
-		const collection =  json.collection;
+		const packageName = json.packageName;
+		const collection = json.collection;
+		const versioned = json.version;
 
-		const content = acc ? iconAccTemplate(name, pathData, ltr, acc, collection, packageName) : iconTemplate(name, pathData, ltr, collection, packageName);
+		const content = acc ? iconAccTemplate(name, pathData, ltr, acc, collection, packageName, versioned) : 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)));
@@ -91,24 +93,27 @@ const createIcons = async (file) => {
 
 		// 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/v5/accept.js"
 		// - "@ui5/ui5-webcomponents-icons/dist/v4/accept.js"
 
-		if (json.version) {
+		if (versioned) {
 			// 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)));
+			promises.push(fs.writeFile(path.join(path.normalize("dist/"), `${name}.d.ts`), collectionTypeDefinitionTemplate(effectiveName, acc)));
 		}
 	}
 
-	return Promise.all(promises);
+	return Promise.all(promises)
+		.then(() => {
+			console.log("Icons created.");
+		});
 };
 
-const isDefaultCollection = collectionName => collectionName === "SAP-icons-v4"  || collectionName === "SAP-icons-v5";
+const isDefaultCollection = collectionName => collectionName === "SAP-icons-v4" || collectionName === "SAP-icons-v5";
 const getUnversionedFullIconName = (name, collection) => `${getUnversionedCollectionName(collection)}/${name}`;
 const getUnversionedCollectionName = collectionName => CollectionVersionedToUnversionedMap[collectionName] || collectionName;
 
@@ -119,6 +124,8 @@ const CollectionVersionedToUnversionedMap = {
 	"business-suite-v2": "business-suite",
 };
 
-createIcons(srcFile).then(() => {
-	console.log("Icons created.");
-});
+if (require.main === module) {
+	createIcons(process.argv)
+}
+
+exports._ui5mainFn = createIcons;

package/lib/create-illustrations/index.js

@@ -1,11 +1,10 @@
 const fs = require("fs").promises;
 const path = require("path");
 
-if (process.argv.length < 7) {
-	throw new Error("Not enough arguments");
-}
-
-const generate = async () => {
+const generate = async (argv) => {
+	if (argv.length < 7) {
+		throw new Error("Not enough arguments");
+	}
 
 	const ORIGINAL_TEXTS = {
 		UnableToLoad: "UnableToLoad",
@@ -20,7 +19,15 @@ const generate = async () => {
 		SuccessScreen: "SuccessScreen",
 		NoMail: "NoMail",
 		NoSavedItems: "NoSavedItems",
-		NoTasks: "NoTasks"
+		NoTasks: "NoTasks",
+		NoDimensionsSet: "NoDimensionsSet",
+		AddPeople: "AddPeople",
+		AddColumn: "AddColumn",
+		SortColumn: "SortColumn",
+		FilterTable: "FilterTable",
+		ResizeColumn: "ResizeColumn",
+		GroupTable: "GroupTable",
+		UploadCollection: "UploadCollection"
 	};
 
 	const FALLBACK_TEXTS = {
@@ -47,28 +54,56 @@ const generate = async () => {
 		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 = 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 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
+	// 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);
+	}
+
+	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 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]);
+		}
+
 		return fs.writeFile(path.join(destPath, fileName), fileContent);
 	};
 	const illustrationImportTemplate = illustrationName => {
@@ -83,55 +118,53 @@ const generate = async () => {
 		}
 
 		const illustrationNameUpperCase = illustrationNameForTranslation.toUpperCase();
+		// If no Dot is present, Spot will be imported as Dot
+		const hasDot = dotIllustrationNames.indexOf(illustrationName) !== -1 ? 'Dot' : 'Spot';
 
-		return defaultText ? `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
+		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 };`
 	};
 
 	await fs.mkdir(destPath, { recursive: true });
@@ -149,13 +182,23 @@ export {
 		}
 	});
 
-	for (let illustrationName of fileNames) {
-		promises.push(fs.writeFile(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(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(promises);
+			return Promise.all(nestedPromises);
+		})
+		.then(() => {
+			console.log("Illustrations generated.");
+		});
 };
 
-generate().then(() => {
-	console.log("Illustrations generated.");
-});
+if (require.main === module) {
+	generate(process.argv)
+}
+
+exports._ui5mainFn = generate;