@ui5/webcomponents-tools 0.0.0-1e08ebdef → 0.0.0-1f45608ac

package/components-package/postcss.themes.js

@@ -1,5 +1,5 @@
 const postcssImport = require('postcss-import');
-const combineSelectors = require('postcss-combine-duplicated-selectors');
+const combineSelectors = require('../lib/postcss-combine-duplicated-selectors/index.js');
 const postcssCSStoJSON = require('../lib/postcss-css-to-json/index.js');
 const postcssCSStoESM = require('../lib/postcss-css-to-esm/index.js');
 const cssnano = require('cssnano');
@@ -8,19 +8,19 @@ const fs = require("fs");
 const packageName = JSON.parse(fs.readFileSync("./package.json")).name;
 
 module.exports = {
-	plugins: [
-		postcssImport(),
-		combineSelectors({
-			removeDuplicatedProperties: true
-		}),
-		cssnano({
-			preset: [
-				'default', {
-					mergeLonghand: false, // https://github.com/cssnano/cssnano/issues/675
-				},
-			]
-		},),
-		postcssCSStoJSON({toReplace: 'src', packageName}),
-		postcssCSStoESM({toReplace: 'src', packageName}),
-	]
+		plugins: [
+			postcssImport(),
+			combineSelectors({
+				removeDuplicatedProperties: true
+			}),
+			cssnano({
+				preset: [
+					'default', {
+						mergeLonghand: false, // https://github.com/cssnano/cssnano/issues/675
+					},
+				]
+			},),
+			postcssCSStoJSON({ toReplace: 'src', packageName }),
+			postcssCSStoESM({ toReplace: 'src', packageName }),
+		]
 };

package/components-package/vite.config.js

@@ -0,0 +1,12 @@
+// vite.config.js
+const { defineConfig } = require('vite');
+const virtualIndex = require("../lib/dev-server/virtual-index-html-plugin.js");
+
+module.exports = defineConfig(async () => {
+	return {
+		build: {
+			emptyOutDir: false,
+		},
+		plugins: [await virtualIndex()],
+	}
+});

package/components-package/wdio.js

@@ -50,7 +50,7 @@ exports.config = {
 		// maxInstances can get overwritten per capability. So if you have an in-house Selenium
 		// grid with only 5 firefox instances available you can make sure that not more than
 		// 5 instances get started at a time.
-		maxInstances: process.env.TRAVIS ? 1 : 5,
+		maxInstances: 5,
 		//
 		browserName: 'chrome',
 		'goog:chromeOptions': {
@@ -82,7 +82,7 @@ exports.config = {
 	// with `/`, the base url gets prepended, not including the path portion of your baseUrl.
 	// If your `url` parameter starts without a scheme or `/` (like `some/path`), the base url
 	// gets prepended directly.
-	baseUrl: undefined, // This is important since WDIO 7+ does not accept an empty string for baseUrl
+	baseUrl: 'http://localhost:4567', // This is important since WDIO 7+ does not accept an empty string for baseUrl
 	path: '',
 	//
 	// Default timeout for all waitFor* commands.
@@ -99,7 +99,14 @@ exports.config = {
 	// Services take over a specific job you don't want to take care of. They enhance
 	// your test setup with almost no effort. Unlike plugins, they don't add new
 	// commands. Instead, they hook themselves up into the test process.
-	services: ['chromedriver'],
+	services: ['chromedriver', 'devtools',
+		['static-server', {
+			folders: [
+				{ mount: '/', path: './dist' },
+			],
+			port: '4567',
+		}],
+	],
 	// options
 	chromeDriverArgs: ['--port=9515'], // default
 	// Framework you want to run your specs with.
@@ -168,6 +175,21 @@ exports.config = {
 			}, this);
 		}, true);
 
+		await browser.addCommand("isFocusedDeepElement", async function (element) {
+			return browser.executeAsync(function (elem, element, done) {
+				let activeElement = document.activeElement;
+
+				while (activeElement.shadowRoot) {
+					if (activeElement.shadowRoot.activeElement) {
+						activeElement = activeElement.shadowRoot.activeElement;
+					} else {
+						break;
+					}
+				}
+				done(element === activeElement);
+			}, this, element);
+		}, true);
+
 		await browser.addCommand("setProperty", async function(property, value) {
 			return browser.executeAsync((elem, property, value, done) => {
 				elem[property] = value;
@@ -195,6 +217,12 @@ exports.config = {
 			}, this, className);
 		}, true);
 
+		await browser.addCommand("hasAttribute", async function(attrName) {
+			return browser.executeAsync((elem, attrName, done) => {
+				done(elem.hasAttribute(attrName));
+			}, this, attrName);
+		}, true);
+
 		await browser.addCommand("getStaticAreaItemClassName", async function(selector) {
 			return browser.executeAsync(async (selector, done) => {
 				const staticAreaItem = await document.querySelector(selector).getStaticAreaItemDomRef();
@@ -216,6 +244,7 @@ exports.config = {
 			"$",
 			"$$",
 			"getAttribute",
+			"hasAttribute", // custom
 			"getCSSProperty",
 			"getHTML",
 			"getProperty",
@@ -230,6 +259,7 @@ exports.config = {
 			"isExisting",
 			"isFocused",
 			"isFocusedDeep", // custom
+			"isFocusedDeepElement", // custom
 			"shadow$",
 			"shadow$$",
 		];
@@ -300,7 +330,6 @@ exports.config = {
 			"click",
 			"doubleClick",
 			"dragAndDrop",
-			"keys",
 			"pause",
 			"removeAttribute", // custom
 			"scrollIntoView",
@@ -311,10 +340,21 @@ exports.config = {
 			"touchAction",
 			"url",
 		];
+
+		const waitForWithDelay = [
+			"keys",
+		];
+
 		if (waitFor.includes(commandName)) {
 			await browser.executeAsync(function (done) {
 				window["sap-ui-webcomponents-bundle"].renderFinished().then(done);
 			});
+		} else if (waitForWithDelay.includes(commandName)) {
+			await browser.executeAsync(function (done) {
+				setTimeout(() => {
+					window["sap-ui-webcomponents-bundle"].renderFinished().then(done);
+				}, 10);
+			});
 		}
 	},
 	/**

package/components-package/wdio.sync.js

@@ -50,7 +50,7 @@ exports.config = {
 		// maxInstances can get overwritten per capability. So if you have an in-house Selenium
 		// grid with only 5 firefox instances available you can make sure that not more than
 		// 5 instances get started at a time.
-		maxInstances: process.env.TRAVIS ? 1 : 5,
+		maxInstances: 5,
 		//
 		browserName: 'chrome',
 		'goog:chromeOptions': {
@@ -168,6 +168,21 @@ exports.config = {
 			}, this);
 		}, true);
 
+		browser.addCommand("isFocusedDeepElement", function (element) {
+			return browser.execute(function (elem, element, done) {
+				let activeElement = document.activeElement;
+
+				while (activeElement.shadowRoot) {
+					if (activeElement.shadowRoot.activeElement) {
+						activeElement = activeElement.shadowRoot.activeElement;
+					} else {
+						break;
+					}
+				}
+				done(element === activeElement);
+			}, this, element);
+		}, true);
+
 		browser.addCommand("setProperty", function(property, value) {
 			return browser.execute((elem, property, value) => {
 				return elem[property] = value;
@@ -223,6 +238,7 @@ exports.config = {
 			"isExisting",
 			"isFocused",
 			"isFocusedDeep", // custom
+			"isFocusedDeepElement", // custom
 			"shadow$",
 			"shadow$$",
 		];

package/icons-collection/nps.js

@@ -1,9 +1,4 @@
 const path = require("path");
-const resolve = require("resolve");
-
-const generateHash = resolve.sync("@ui5/webcomponents-tools/lib/hash/generate.js");
-const hashIsUpToDate = resolve.sync("@ui5/webcomponents-tools/lib/hash/upToDate.js");
-const UP_TO_DATE = `node "${hashIsUpToDate}" dist/ hash.txt && echo "Up to date."`;
 
 const LIB = path.join(__dirname, `../lib/`);
 
@@ -46,15 +41,17 @@ const copyIconAssetsCommand = (options) => {
 const getScripts = (options) => {
 	const createJSImportsCmd = createIconImportsCommand(options);
 	const copyAssetsCmd = copyIconAssetsCommand(options);
+	const tsCommand = options.typescript ? "tsc" : "";
+	const tsCrossEnv = options.typescript ? "cross-env UI5_TS=true" : "";
 
 	const scripts = {
-		clean: "rimraf dist",
+		clean: "rimraf dist && rimraf src/generated",
 		copy: copyAssetsCmd,
 		build: {
-			default: `${UP_TO_DATE} || nps clean copy build.i18n build.icons build.jsonImports hash`,
+			default: `${tsCrossEnv} nps clean copy build.i18n typescript build.icons build.jsonImports`,
 			i18n: {
 				default: "nps build.i18n.defaultsjs build.i18n.json",
-				defaultsjs: `mkdirp dist/generated/i18n && node "${LIB}/i18n/defaults.js" src/i18n dist/generated/i18n`,
+				defaultsjs: `mkdirp dist/generated/i18n && node "${LIB}/i18n/defaults.js" src/i18n src/generated/i18n`,
 				json: `mkdirp dist/generated/assets/i18n && node "${LIB}/i18n/toJSON.js" src/i18n dist/generated/assets/i18n`,
 			},
 			jsonImports: {
@@ -63,7 +60,7 @@ const getScripts = (options) => {
 			},
 			icons: createJSImportsCmd,
 		},
-		hash: `node "${generateHash}" dist/ hash.txt`,
+		typescript: tsCommand,
 	};
 
 	return scripts;

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

@@ -1,9 +1,32 @@
+/*
+MIT License
+
+Copyright (c) 2017
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+ */
+
 const fs = require('fs');
 const path = require('path');
 const chokidar = require('chokidar');
 const glob = require('glob');
 const globParent = require('glob-parent');
-require('colors');
 
 /* CODE */
 

package/lib/copy-list/index.js

@@ -1,28 +1,28 @@
-const fs = require("fs");
+const fs = require("fs").promises;
 const path = require("path");
-const mkdirp = require("mkdirp");
 
 const fileList = process.argv[2];
 const dest = process.argv[3];
-const src = "../../node_modules/@openui5/sap.ui.core/src/";
+const src = "@openui5/sap.ui.core/src/";
 
-const filesToCopy = fs.readFileSync(fileList).toString();
-// console.log(filesToCopy);
+const generate = async () => {
+	const filesToCopy = (await fs.readFile(fileList)).toString();
+	// console.log(filesToCopy);
 
-// Support full-line comments starting with # in the used-modules.txt file
-const shouldCopy = file => file.length && !file.startsWith("#");
+	// Support full-line comments starting with # in the used-modules.txt file
+	const shouldCopy = file => file.length && !file.startsWith("#");
 
-const trimFile = file => file.trim();
+	const trimFile = file => file.trim();
 
-filesToCopy.split("\n").map(trimFile).filter(shouldCopy).forEach(async moduleName => {
-	const srcPath = path.join(src, moduleName);
-	const destPath = path.join(dest, moduleName);
+	return 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 mkdirp(path.dirname(destPath));
-    fs.copyFile(srcPath, destPath, (err) => {
-    	if (err) {
-    		throw err;
-		}
-		console.log(`${destPath} created.`);
+		await fs.mkdir(path.dirname(destPath), { recursive: true });
+		return fs.copyFile(srcPath, destPath);
 	});
+};
+
+generate().then(() => {
+	console.log("Files copied.");
 });

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 { isTheme } from "@ui5/webcomponents-base/dist/config/Theme.js";
-import pathDataV4 from "./v5/${name}.js";
-import pathDataV5 from "./v4/${name}.js";
-const pathData = isTheme("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 { isThemeFamily } 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 = isThemeFamily("sap_horizon") ? pathData${versions[1]} : pathData${versions[0]};
+
+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.");
+});