@ui5/webcomponents-tools 0.0.0-d0bcf47c7 → 0.0.0-d473b9686

package/lib/create-icons/index.js

@@ -0,0 +1,126 @@
+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 { 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 getPathData = async() => {
+	return await isLegacyThemeFamilyAsync() ? pathDatav4 : pathDatav5;
+};
+
+export default "${fullName}";
+export { getPathData, 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 getPathData: () => Promise<string>;
+declare const ltr: boolean;
+declare const accData: ${accData ? '{ key: string; defaultText: string; }' : null}
+declare const _default: "${name}";
+
+export default _default;
+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) => {
+	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,182 @@
+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();
+
+	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 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 => {
+		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 { 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 dotSvg from "./${illustrationsPrefix}-${hasDot}-${illustrationName}.js";${
+	defaultText ? `import {
+	IM_TITLE_${illustrationNameUpperCase},
+	IM_SUBTITLE_${illustrationNameUpperCase},
+} 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};` : ``}
+
+registerIllustration(name, {
+	dialogSvg,
+	sceneSvg,
+	spotSvg,
+	dotSvg,${defaultText ? `
+	title,
+	subtitle,` : ``}
+	set,
+	collection,
+});
+
+export default "${illustrationSet === "fiori" ? "" : `${illustrationSet}/`}${illustrationName}";
+export {
+	dialogSvg,
+	sceneSvg,
+	spotSvg,
+	dotSvg,
+};`
+	};
+
+	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 default _default;
+export { dialogSvg, sceneSvg, spotSvg, dotSvg };`
+	};
+
+	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);
+		}
+	});
+
+	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);
+	});
+};
+
+generate().then(() => {
+	console.log("Illustrations generated.");
+});

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

@@ -0,0 +1,114 @@
+const fs = require("fs");
+const path = require("path");
+const prompts = require("prompts");
+const jsFileContentTemplate = require("./jsFileContentTemplate.js");
+const tsFileContentTemplate = require("./tsFileContentTemplate.js");
+
+/**
+ * Hyphanates the given PascalCase string, f.e.:
+ * Foo -> "my-foo" (adds preffix)
+ * FooBar -> "foo-bar"
+ */
+const hyphaneteComponentName = (componentName) => {
+	const result = componentName.replace(/([a-z])([A-Z])/g, '$1-$2' ).toLowerCase();
+
+	return result.includes("-") ? result : `my-${result}`;
+};
+
+/**
+ * Capitalizes first letter of string.
+ */
+const capitalizeFirstLetter = string => string.charAt(0).toUpperCase() + string.slice(1);
+
+/**
+ * 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")) {
+		throw("The current directory doesn't contain package.json file.");
+	}
+
+	const packageJSON = JSON.parse(fs.readFileSync("./package.json"));
+
+	if (!packageJSON.name) {
+		throw("The package.json file in the current directory doesn't have a name property");
+	}
+
+	return packageJSON.name;
+};
+
+const getLibraryName = packageName => {
+	if (!packageName.includes("/")) {
+		return packageName;
+	}
+
+	if (packageName === "@ui5/webcomponents") {
+		return `main`;
+	}
+
+	packageName = packageName.split("/").pop();
+
+	if (!packageName.startsWith("webcomponents-")) {
+		return packageName;
+	}
+
+	return packageName.substr("webcomponents-".length);
+};
+
+const generateFiles = (componentName, tagName, library, packageName) => {
+	componentName = capitalizeFirstLetter(componentName);
+	const filePaths = {
+		"main": `./src/${componentName}.ts`,
+		"css": `./src/themes/${componentName}.css`,
+		"template": `./src/${componentName}.hbs`,
+	};
+
+	fs.writeFileSync(filePaths.main, tsFileContentTemplate(componentName, tagName, library, packageName), { 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";`);
+}
+
+// Main function
+const createWebComponent = async () => {
+	const packageName = getPackageName();
+	const library = getLibraryName(packageName);
+
+	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.`);
+	}
+
+	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 tagName = hyphaneteComponentName(componentName);
+
+	generateFiles(componentName, tagName, library, packageName);
+};
+
+createWebComponent();

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

@@ -0,0 +1,71 @@
+const tsFileContentTemplate = (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.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";
+
+/**
+ * @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: litRender,
+	styles: ${componentName}Css,
+	template: ${componentName}Template,
+	dependencies: [],
+})
+
+/**
+ * Example custom event.
+ * Please keep in mind that all public events should be documented in the API Reference as shown below.
+ *
+ * @public
+ */
+@event("interact", { detail: { /* event payload ( optional ) */ } })
+class ${componentName} extends UI5Element {
+	/**
+	 * 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 = tsFileContentTemplate;

package/lib/css-processors/css-processor-component-styles.mjs

@@ -0,0 +1,48 @@
+import { globby } from "globby";
+import * as esbuild from 'esbuild'
+import * as fs from "fs";
+import * as path from "path";
+import { writeFile, mkdir } from "fs/promises";
+import scopeVariables from "./scope-variables.mjs";
+
+const packageJSON = JSON.parse(fs.readFileSync("./package.json"))
+const inputFiles = await globby("src/styles/*.module.css");
+const restArgs = process.argv.slice(2);
+
+let componentStylesPlugin = {
+    name: 'component-styles',
+    setup(build) {
+        build.initialOptions.write = false;
+
+        build.onEnd(result => {
+            result.outputFiles.forEach(async f => {
+                // scoping
+                const newText = scopeVariables(f.text, packageJSON);
+                await mkdir(path.dirname(f.path), {recursive: true});
+                writeFile(f.path, newText);
+                writeFile(f.path.replace(".module.css", ".css"), newText);
+            });
+        })
+    },
+}
+
+const config = {
+    entryPoints: inputFiles,
+    outdir: 'dist',
+    bundle: true,
+    outbase: 'src',
+    loader: {
+        ".module.css": "global-css"
+    },
+    plugins: [
+        componentStylesPlugin,
+    ]
+};
+
+if (restArgs.includes("-w")) {
+    let ctx = await esbuild.context(config);
+    await ctx.watch()
+    console.log('watching...')
+} else {
+    await esbuild.build(config);
+}

package/lib/css-processors/css-processor-components.mjs

@@ -0,0 +1,77 @@
+import { globby } from "globby";
+import * as esbuild from 'esbuild'
+import * as fs from "fs";
+import * as path from "path";
+import { writeFile, mkdir } from "fs/promises";
+import chokidar from "chokidar";
+import scopeVariables from "./scope-variables.mjs";
+import { writeFileIfChanged, getFileContent } from "./shared.mjs";
+
+const tsMode = process.env.UI5_TS === "true";
+const extension = tsMode ? ".css.ts" : ".css.js";
+
+const packageJSON = JSON.parse(fs.readFileSync("./package.json"))
+const inputFilesGlob = "src/themes/*.css";
+const restArgs = process.argv.slice(2);
+
+let customPlugin = {
+    name: 'ui5-tools',
+    setup(build) {
+        build.initialOptions.write = false;
+
+        build.onEnd(result => {
+            result.outputFiles.forEach(async f => {
+                // scoping
+                const newText = scopeVariables(f.text, packageJSON);
+                await mkdir(path.dirname(f.path), {recursive: true});
+                writeFile(f.path, newText);
+
+                // JS/TS
+                const jsPath = f.path.replace(/dist[\/\\]css/, "src/generated/").replace(".css", extension);
+                const jsContent = getFileContent(tsMode, jsPath, packageJSON.name, "\`" + newText + "\`", true);
+                writeFileIfChanged(jsPath, jsContent);
+            });
+        })
+    },
+}
+
+const getConfig = async () => {
+    const config = {
+        entryPoints: await globby(inputFilesGlob),
+        bundle: true,
+        minify: true,
+        outdir: 'dist/css',
+        outbase: 'src',
+        plugins: [
+            customPlugin,
+        ]
+    };
+    return config;
+}
+
+if (restArgs.includes("-w")) {
+    let ready;
+    let config = await getConfig();
+    let ctx = await esbuild.context(config);
+    await ctx.watch()
+    console.log('watching...')
+
+    // when new component css files are added, they do not trigger a build as no one directly imports them
+    // restart the watch mode with the new entry points if a css file is added.
+    const watcher = chokidar.watch(inputFilesGlob);
+    watcher.on("ready", () => {
+        ready = true; // Initial scan is over -> waiting for new files
+    });
+    watcher.on("add", async path => {
+        if (ready) {
+            // new file
+            ctx.dispose();
+            config = await getConfig();
+            ctx = await esbuild.context(config);
+            ctx.watch();
+        }
+    });
+} else {
+    const config = await getConfig();
+    const result = await esbuild.build(config);
+}