@ui5/webcomponents-tools 0.0.0-453158269 → 0.0.0-4738ea0dc
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +174 -0
- package/README.md +5 -6
- package/bin/dev.js +1 -5
- package/components-package/eslint.js +28 -0
- package/components-package/nps.js +79 -45
- package/components-package/postcss.components.js +13 -13
- package/components-package/postcss.themes.js +15 -15
- package/components-package/vite.config.js +12 -0
- package/components-package/wdio.js +28 -4
- package/components-package/wdio.sync.js +1 -1
- package/icons-collection/nps.js +6 -3
- package/lib/copy-list/index.js +2 -2
- package/lib/create-icons/index.js +52 -10
- package/lib/create-new-component/index.js +5 -5
- package/lib/dev-server/dev-server.js +66 -0
- package/lib/dev-server/virtual-index-html-plugin.js +53 -0
- package/lib/generate-custom-elements-manifest/index.js +327 -0
- package/lib/generate-js-imports/illustrations.js +72 -0
- package/lib/hbs2lit/src/compiler.js +8 -0
- package/lib/hbs2lit/src/litVisitor2.js +46 -8
- package/lib/i18n/defaults.js +18 -2
- package/lib/jsdoc/configTypescript.json +29 -0
- package/lib/jsdoc/plugin.js +32 -0
- package/lib/jsdoc/preprocess.js +146 -0
- package/lib/jsdoc/template/publish.js +9 -1
- package/lib/postcss-css-to-esm/index.js +51 -6
- package/lib/postcss-css-to-json/index.js +12 -1
- package/lib/postcss-p/postcss-p.mjs +3 -0
- package/lib/scoping/get-all-tags.js +1 -8
- package/lib/scoping/scope-test-pages.js +1 -1
- package/lib/test-runner/test-runner.js +63 -0
- package/package.json +15 -16
- package/components-package/rollup-plugins/empty-module.js +0 -15
- package/components-package/rollup.js +0 -150
- package/lib/documentation/index.js +0 -168
- package/lib/documentation/templates/api-component-since.js +0 -3
- package/lib/documentation/templates/api-css-variables-section.js +0 -24
- package/lib/documentation/templates/api-events-section.js +0 -35
- package/lib/documentation/templates/api-methods-section.js +0 -26
- package/lib/documentation/templates/api-properties-section.js +0 -42
- package/lib/documentation/templates/api-slots-section.js +0 -28
- package/lib/documentation/templates/template.js +0 -39
- package/lib/serve/index.js +0 -46
- package/lib/serve/serve.json +0 -3
- package/package-lock.json +0 -48
package/lib/copy-list/index.js
CHANGED
@@ -3,7 +3,7 @@ const path = require("path");
|
|
3
3
|
|
4
4
|
const fileList = process.argv[2];
|
5
5
|
const dest = process.argv[3];
|
6
|
-
const src = "
|
6
|
+
const src = "@openui5/sap.ui.core/src/";
|
7
7
|
|
8
8
|
const generate = async () => {
|
9
9
|
const filesToCopy = (await fs.readFile(fileList)).toString();
|
@@ -15,7 +15,7 @@ const generate = async () => {
|
|
15
15
|
const trimFile = file => file.trim();
|
16
16
|
|
17
17
|
return filesToCopy.split("\n").map(trimFile).filter(shouldCopy).map(async moduleName => {
|
18
|
-
const srcPath = path.join(src, moduleName);
|
18
|
+
const srcPath = require.resolve(path.join(src, moduleName), {paths: [process.cwd()]});
|
19
19
|
const destPath = path.join(dest, moduleName);
|
20
20
|
|
21
21
|
await fs.mkdir(path.dirname(destPath), { recursive: true });
|
@@ -1,7 +1,7 @@
|
|
1
1
|
const fs = require("fs").promises;
|
2
2
|
const path = require("path");
|
3
3
|
|
4
|
-
const collectionName = process.argv[2] || "SAP-icons";
|
4
|
+
const collectionName = process.argv[2] || "SAP-icons-v4";
|
5
5
|
const collectionVersion = process.argv[3];
|
6
6
|
const srcFile = collectionVersion ? path.normalize(`src/${collectionVersion}/${collectionName}.json`) : path.normalize(`src/${collectionName}.json`);
|
7
7
|
const destDir = collectionVersion ? path.normalize(`dist/${collectionVersion}/`) : path.normalize("dist/");
|
@@ -17,7 +17,7 @@ const packageName = "${packageName}";
|
|
17
17
|
|
18
18
|
registerIcon(name, { pathData, ltr, collection, packageName });
|
19
19
|
|
20
|
-
export default "${name}";
|
20
|
+
export default "${collection}/${name}";
|
21
21
|
export { pathData, ltr, accData };`;
|
22
22
|
|
23
23
|
|
@@ -33,21 +33,38 @@ const packageName = "${packageName}";
|
|
33
33
|
|
34
34
|
registerIcon(name, { pathData, ltr, accData, collection, packageName });
|
35
35
|
|
36
|
-
export default "${name}";
|
36
|
+
export default "${collection}/${name}";
|
37
37
|
export { pathData, ltr, accData };`;
|
38
38
|
|
39
39
|
|
40
40
|
|
41
|
-
const collectionTemplate = (name) => `import { isThemeFamily } from "@ui5/webcomponents-base/dist/config/Theme.js";
|
42
|
-
import {pathData as
|
43
|
-
import {pathData as
|
41
|
+
const collectionTemplate = (name, versions, fullName) => `import { isThemeFamily } from "@ui5/webcomponents-base/dist/config/Theme.js";
|
42
|
+
import { pathData as pathData${versions[0]}, ltr, accData } from "./${versions[0]}/${name}.js";
|
43
|
+
import { pathData as pathData${versions[1]} } from "./${versions[1]}/${name}.js";
|
44
44
|
|
45
|
-
const pathData = isThemeFamily("sap_horizon") ?
|
45
|
+
const pathData = isThemeFamily("sap_horizon") ? pathData${versions[1]} : pathData${versions[0]};
|
46
46
|
|
47
|
-
export default "${
|
47
|
+
export default "${fullName}";
|
48
48
|
export { pathData, ltr, accData };`;
|
49
49
|
|
50
50
|
|
51
|
+
const typeDefinitionTemplate = (name, accData, collection) => `declare const pathData: string;
|
52
|
+
declare const ltr: boolean;
|
53
|
+
declare const accData: ${accData ? '{ key: string; defaultText: string; }' : null}
|
54
|
+
declare const _default: "${collection}/${name}";
|
55
|
+
|
56
|
+
export default _default;
|
57
|
+
export { pathData, ltr, accData };`
|
58
|
+
|
59
|
+
const collectionTypeDefinitionTemplate = (name, accData) => `declare const pathData: string;
|
60
|
+
declare const ltr: boolean;
|
61
|
+
declare const accData: ${accData ? '{ key: string; defaultText: string; }' : null}
|
62
|
+
declare const _default: "${name}";
|
63
|
+
|
64
|
+
export default _default;
|
65
|
+
export { pathData, ltr, accData };`
|
66
|
+
|
67
|
+
|
51
68
|
const svgTemplate = (pathData) => `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
|
52
69
|
<path d="${pathData}"/>
|
53
70
|
</svg>`;
|
@@ -63,20 +80,45 @@ const createIcons = async (file) => {
|
|
63
80
|
const pathData = iconData.path;
|
64
81
|
const ltr = !!iconData.ltr;
|
65
82
|
const acc = iconData.acc;
|
83
|
+
const packageName = json.packageName;
|
84
|
+
const collection = json.collection;
|
66
85
|
|
67
|
-
const content = acc ? iconAccTemplate(name, pathData, ltr, acc,
|
86
|
+
const content = acc ? iconAccTemplate(name, pathData, ltr, acc, collection, packageName) : iconTemplate(name, pathData, ltr, collection, packageName);
|
68
87
|
|
69
88
|
promises.push(fs.writeFile(path.join(destDir, `${name}.js`), content));
|
70
89
|
promises.push(fs.writeFile(path.join(destDir, `${name}.svg`), svgTemplate(pathData)));
|
90
|
+
promises.push(fs.writeFile(path.join(destDir, `${name}.d.ts`), typeDefinitionTemplate(name, acc, collection)));
|
91
|
+
|
92
|
+
// For versioned icons collections, the script creates top level (unversioned) module that internally imports the versioned ones.
|
93
|
+
// For example, the top level "@ui5/ui5-webcomponents-icons/dist/accept.js" imports:
|
94
|
+
// - "@ui5/ui5-webcomponents-icons/dist/v5/accept.js"
|
95
|
+
// - "@ui5/ui5-webcomponents-icons/dist/v4/accept.js"
|
71
96
|
|
72
97
|
if (json.version) {
|
73
|
-
|
98
|
+
// The exported value from the top level (unversioned) icon module depends on whether the collection is the default,
|
99
|
+
// to add or not the collection name to the exported value:
|
100
|
+
// For the default collection (SAPIcons) we export just the icon name - "export default { 'accept' }"
|
101
|
+
// For non-default collections (SAPTNTIcons and SAPBSIcons) we export the full name - "export default { 'tnt/actor' }"
|
102
|
+
const effectiveName = isDefaultCollection(collection) ? name : getUnversionedFullIconName(name, collection);
|
103
|
+
promises.push(fs.writeFile(path.join(path.normalize("dist/"), `${name}.js`), collectionTemplate(name, json.versions, effectiveName)));
|
104
|
+
promises.push(fs.writeFile(path.join(path.normalize("dist/"), `${name}.d.ts`), collectionTypeDefinitionTemplate(effectiveName, acc)));
|
74
105
|
}
|
75
106
|
}
|
76
107
|
|
77
108
|
return Promise.all(promises);
|
78
109
|
};
|
79
110
|
|
111
|
+
const isDefaultCollection = collectionName => collectionName === "SAP-icons-v4" || collectionName === "SAP-icons-v5";
|
112
|
+
const getUnversionedFullIconName = (name, collection) => `${getUnversionedCollectionName(collection)}/${name}`;
|
113
|
+
const getUnversionedCollectionName = collectionName => CollectionVersionedToUnversionedMap[collectionName] || collectionName;
|
114
|
+
|
115
|
+
const CollectionVersionedToUnversionedMap = {
|
116
|
+
"tnt-v2": "tnt",
|
117
|
+
"tnt-v3": "tnt",
|
118
|
+
"business-suite-v1": "business-suite",
|
119
|
+
"business-suite-v2": "business-suite",
|
120
|
+
};
|
121
|
+
|
80
122
|
createIcons(srcFile).then(() => {
|
81
123
|
console.log("Icons created.");
|
82
124
|
});
|
@@ -13,13 +13,13 @@ import ${componentName}Css from "./generated/themes/${componentName}.css.js";
|
|
13
13
|
*/
|
14
14
|
const metadata = {
|
15
15
|
tag: "${tagName}",
|
16
|
-
properties: /** @lends sap.ui.
|
16
|
+
properties: /** @lends sap.ui.webc.${library}.${componentName}.prototype */ {
|
17
17
|
//
|
18
18
|
},
|
19
|
-
slots: /** @lends sap.ui.
|
19
|
+
slots: /** @lends sap.ui.webc.${library}.${componentName}.prototype */ {
|
20
20
|
//
|
21
21
|
},
|
22
|
-
events: /** @lends sap.ui.
|
22
|
+
events: /** @lends sap.ui.webc.${library}.${componentName}.prototype */ {
|
23
23
|
//
|
24
24
|
},
|
25
25
|
};
|
@@ -39,8 +39,8 @@ const metadata = {
|
|
39
39
|
*
|
40
40
|
* @constructor
|
41
41
|
* @author SAP SE
|
42
|
-
* @alias sap.ui.
|
43
|
-
* @extends UI5Element
|
42
|
+
* @alias sap.ui.webc.${library}.${componentName}
|
43
|
+
* @extends sap.ui.webc.base.UI5Element
|
44
44
|
* @tagname ${tagName}
|
45
45
|
* @public
|
46
46
|
*/
|
@@ -0,0 +1,66 @@
|
|
1
|
+
const fs = require("fs/promises");
|
2
|
+
const { createServer } = require('vite');
|
3
|
+
const yargs = require('yargs/yargs')
|
4
|
+
const { hideBin } = require('yargs/helpers')
|
5
|
+
|
6
|
+
const argv = yargs(hideBin(process.argv))
|
7
|
+
.alias("c", "config")
|
8
|
+
.argv;
|
9
|
+
|
10
|
+
const startVite = async (port) => {
|
11
|
+
const server = await createServer({
|
12
|
+
configFile: argv.config,
|
13
|
+
server: {
|
14
|
+
port: port,
|
15
|
+
strictPort: true,
|
16
|
+
open: true,
|
17
|
+
host: true,
|
18
|
+
},
|
19
|
+
logLevel: 'info',
|
20
|
+
clearScreen: false,
|
21
|
+
})
|
22
|
+
await server.listen()
|
23
|
+
server.printUrls()
|
24
|
+
return server;
|
25
|
+
};
|
26
|
+
|
27
|
+
const rmPortFile = async () => {
|
28
|
+
// exit handler must be sync
|
29
|
+
try {
|
30
|
+
await fs.rm(".dev-server-port");
|
31
|
+
} catch (e) {}
|
32
|
+
process.exit();
|
33
|
+
}
|
34
|
+
|
35
|
+
["exit", "SIGINT", "SIGUSR1", "SIGUSR2", "uncaughtException", "SIGTERM"].forEach((eventType) => {
|
36
|
+
process.on(eventType, rmPortFile);
|
37
|
+
});
|
38
|
+
|
39
|
+
(async () => {
|
40
|
+
let retries = 10;
|
41
|
+
let port = 8080;
|
42
|
+
while (retries--) {
|
43
|
+
console.log(`taking port ${port}`);
|
44
|
+
await fs.writeFile(".dev-server-port", `${port}`);
|
45
|
+
try {
|
46
|
+
// execSync(command, {stdio: 'pipe'});
|
47
|
+
const server = await startVite(port);
|
48
|
+
if (server) {
|
49
|
+
// server started, don't try other ports
|
50
|
+
break;
|
51
|
+
}
|
52
|
+
} catch (e) {
|
53
|
+
// uncomment for debug
|
54
|
+
// console.log(e.toString());
|
55
|
+
if (e.toString().includes("already in use")) {
|
56
|
+
console.log(`Port ${port} already in use`)
|
57
|
+
port++;
|
58
|
+
continue;
|
59
|
+
}
|
60
|
+
// other error or CTRL-C
|
61
|
+
process.exit();
|
62
|
+
}
|
63
|
+
// no error normal exit
|
64
|
+
// process.exit();
|
65
|
+
}
|
66
|
+
})();
|
@@ -0,0 +1,53 @@
|
|
1
|
+
let path = require("path");
|
2
|
+
|
3
|
+
const virtualIndexPlugin = async () => {
|
4
|
+
const { globby } = await import("globby");
|
5
|
+
const files = await globby(["test/pages/**/*.html", "packages/*/test/pages/**/*.html"]);
|
6
|
+
|
7
|
+
const pagesPerFolder = {};
|
8
|
+
files.forEach(file => {
|
9
|
+
let folder = pagesPerFolder[path.dirname(file)] = pagesPerFolder[path.dirname(file)] || [];
|
10
|
+
folder.push(path.basename(file));
|
11
|
+
});
|
12
|
+
|
13
|
+
const rollupInput = {};
|
14
|
+
|
15
|
+
files.forEach(file => {
|
16
|
+
rollupInput[file] = path.resolve(process.cwd(), file);
|
17
|
+
})
|
18
|
+
|
19
|
+
return {
|
20
|
+
name: 'virtual-index-html',
|
21
|
+
config() {
|
22
|
+
return {
|
23
|
+
build: {
|
24
|
+
rollupOptions: {
|
25
|
+
input: rollupInput
|
26
|
+
}
|
27
|
+
}
|
28
|
+
}
|
29
|
+
},
|
30
|
+
configureServer(server) {
|
31
|
+
server.middlewares.use((req, res, next) => {
|
32
|
+
if (req.url === "/") {
|
33
|
+
const folders = Object.keys(pagesPerFolder);
|
34
|
+
|
35
|
+
res.statusCode = 200;
|
36
|
+
res.setHeader("Content-Type", "text/html; charset=utf-8");
|
37
|
+
res.end(`${folders.map(folder => {
|
38
|
+
const pages = pagesPerFolder[folder];
|
39
|
+
return `<h1>${folder}</h1>
|
40
|
+
${pages.map(page => {
|
41
|
+
return `<li><a href='${folder}/${page}'>${page}</a></li>`
|
42
|
+
}).join("")}
|
43
|
+
`
|
44
|
+
}).join("")}`);
|
45
|
+
} else {
|
46
|
+
next();
|
47
|
+
}
|
48
|
+
})
|
49
|
+
},
|
50
|
+
}
|
51
|
+
};
|
52
|
+
|
53
|
+
module.exports = virtualIndexPlugin;
|
@@ -0,0 +1,327 @@
|
|
1
|
+
const fs = require("fs").promises;
|
2
|
+
const path = require("path");
|
3
|
+
// https://github.com/webcomponents/custom-elements-manifest/blob/main/schema.json
|
4
|
+
|
5
|
+
const inputDir = process.argv[2];
|
6
|
+
const outputDir = process.argv[3];
|
7
|
+
|
8
|
+
const camelToKebabMap = new Map();
|
9
|
+
const apiIndex = new Map();
|
10
|
+
const forbiddenAttributeTypes = ["object", "array"];
|
11
|
+
|
12
|
+
const camelToKebabCase = string => {
|
13
|
+
if (!camelToKebabMap.has(string)) {
|
14
|
+
const result = string.replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase();
|
15
|
+
camelToKebabMap.set(string, result);
|
16
|
+
}
|
17
|
+
return camelToKebabMap.get(string);
|
18
|
+
};
|
19
|
+
|
20
|
+
const generateJavaScriptExport = entity => {
|
21
|
+
return {
|
22
|
+
declaration: generateRefenrece(entity.name),
|
23
|
+
deprecated: !!entity.deprecated,
|
24
|
+
kind: "js",
|
25
|
+
name: "default",
|
26
|
+
};
|
27
|
+
};
|
28
|
+
|
29
|
+
const generateCustomElementExport = entity => {
|
30
|
+
return {
|
31
|
+
declaration: {
|
32
|
+
name: entity.basename,
|
33
|
+
module: `${entity.module}.js`,
|
34
|
+
},
|
35
|
+
deprecated: !!entity.deprecated,
|
36
|
+
kind: "custom-element-definition",
|
37
|
+
name: entity.tagname,
|
38
|
+
};
|
39
|
+
};
|
40
|
+
|
41
|
+
const generateJavaScriptModule = entity => {
|
42
|
+
return {
|
43
|
+
kind: "javascript-module",
|
44
|
+
path: `${entity.basename}.js`,
|
45
|
+
declarations: [
|
46
|
+
generateCustomElementDeclaration(entity),
|
47
|
+
],
|
48
|
+
exports: [
|
49
|
+
generateJavaScriptExport(entity),
|
50
|
+
generateCustomElementExport(entity),
|
51
|
+
],
|
52
|
+
};
|
53
|
+
};
|
54
|
+
|
55
|
+
const generateSingleClassField = classField => {
|
56
|
+
let generatedClassField = {
|
57
|
+
deprecated: !!classField.deprecated,
|
58
|
+
kind: "field",
|
59
|
+
name: classField.name,
|
60
|
+
privacy: classField.visibility,
|
61
|
+
static: !!classField.static,
|
62
|
+
type: generateType(classField.type),
|
63
|
+
};
|
64
|
+
|
65
|
+
if (classField.defaultValue) {
|
66
|
+
generatedClassField.default = classField.defaultValue;
|
67
|
+
}
|
68
|
+
|
69
|
+
if (classField.description) {
|
70
|
+
generatedClassField.description = classField.description;
|
71
|
+
}
|
72
|
+
|
73
|
+
return generatedClassField;
|
74
|
+
};
|
75
|
+
|
76
|
+
const generateSingleParameter = parameter => {
|
77
|
+
let generatedParameter = {
|
78
|
+
deprecated: !!parameter.deprecated,
|
79
|
+
name: parameter.name,
|
80
|
+
type: generateType(parameter.type),
|
81
|
+
};
|
82
|
+
|
83
|
+
if (parameter.description) {
|
84
|
+
generatedParameter.description = parameter.description;
|
85
|
+
}
|
86
|
+
|
87
|
+
if (parameter.optional) {
|
88
|
+
generatedParameter.optional = parameter.optional;
|
89
|
+
}
|
90
|
+
|
91
|
+
return generatedParameter;
|
92
|
+
};
|
93
|
+
|
94
|
+
const generateParameters = (parameters) => {
|
95
|
+
return parameters.reduce((newParametersArray, parameter) => {
|
96
|
+
newParametersArray.push(generateSingleParameter(parameter));
|
97
|
+
|
98
|
+
return newParametersArray;
|
99
|
+
}, []);
|
100
|
+
};
|
101
|
+
|
102
|
+
const generateSingleClassMethod = classMethod => {
|
103
|
+
let generatedClassMethod = {
|
104
|
+
deprecated: !!classMethod.deprecated,
|
105
|
+
kind: "method",
|
106
|
+
name: classMethod.name,
|
107
|
+
privacy: classMethod.visibility,
|
108
|
+
static: classMethod.static,
|
109
|
+
};
|
110
|
+
|
111
|
+
if (classMethod.description) {
|
112
|
+
generatedClassMethod.description = classMethod.description;
|
113
|
+
}
|
114
|
+
|
115
|
+
if (classMethod.parameters && classMethod.parameters.length) {
|
116
|
+
generatedClassMethod.parameters = generateParameters(classMethod.parameters);
|
117
|
+
}
|
118
|
+
|
119
|
+
if (classMethod.returnValue) {
|
120
|
+
generatedClassMethod.return = {
|
121
|
+
type: generateType(classMethod.returnValue.type),
|
122
|
+
};
|
123
|
+
|
124
|
+
if (classMethod.returnValue.description) {
|
125
|
+
generatedClassMethod.return.description = classMethod.returnValue.type;
|
126
|
+
}
|
127
|
+
}
|
128
|
+
|
129
|
+
return generatedClassMethod;
|
130
|
+
};
|
131
|
+
|
132
|
+
const generateClassFields = classFields => {
|
133
|
+
return classFields.reduce((newClassFieldsArray, classField) => {
|
134
|
+
newClassFieldsArray.push(generateSingleClassField(classField));
|
135
|
+
|
136
|
+
return newClassFieldsArray;
|
137
|
+
}, []);
|
138
|
+
};
|
139
|
+
|
140
|
+
const generateClassMethods = classMethods => {
|
141
|
+
return classMethods.reduce((newClassMethodsArray, classMethod) => {
|
142
|
+
newClassMethodsArray.push(generateSingleClassMethod(classMethod));
|
143
|
+
|
144
|
+
return newClassMethodsArray;
|
145
|
+
}, []);
|
146
|
+
};
|
147
|
+
|
148
|
+
const generateMembers = (classFields, classMethods) => {
|
149
|
+
return [...generateClassFields(classFields), ...generateClassMethods(classMethods)];
|
150
|
+
};
|
151
|
+
|
152
|
+
const generateType = type => {
|
153
|
+
const dataType = apiIndex.get(type);
|
154
|
+
|
155
|
+
return {
|
156
|
+
text: dataType && dataType.name.includes(".types.") ?
|
157
|
+
filterPublicApi(dataType.properties)
|
158
|
+
.map(prop => `"${prop.name}"`)
|
159
|
+
.join(" | ") : type,
|
160
|
+
};
|
161
|
+
};
|
162
|
+
|
163
|
+
const generateSingleAttribute = attribute => {
|
164
|
+
let generatedAttribute = {
|
165
|
+
default: attribute.defaultValue,
|
166
|
+
deprecated: !!attribute.deprecated,
|
167
|
+
fieldName: attribute.name,
|
168
|
+
name: camelToKebabCase(attribute.name),
|
169
|
+
type: generateType(attribute.type),
|
170
|
+
};
|
171
|
+
|
172
|
+
if (attribute.description) {
|
173
|
+
generatedAttribute.description = attribute.description;
|
174
|
+
}
|
175
|
+
|
176
|
+
return generatedAttribute;
|
177
|
+
};
|
178
|
+
|
179
|
+
const generateAttributes = attributes => {
|
180
|
+
attributes = attributes.reduce((newAttributesArray, attribute) => {
|
181
|
+
newAttributesArray.push(generateSingleAttribute(attribute));
|
182
|
+
|
183
|
+
return newAttributesArray;
|
184
|
+
}, []);
|
185
|
+
|
186
|
+
return attributes;
|
187
|
+
};
|
188
|
+
|
189
|
+
const generateSingleEvent = event => {
|
190
|
+
let generatedEvent = {
|
191
|
+
deprecated: !!event.deprecated,
|
192
|
+
name: event.name,
|
193
|
+
type: event.native === "true" ? "NativeEvent" : "CustomEvent",
|
194
|
+
};
|
195
|
+
|
196
|
+
if (event.description) {
|
197
|
+
generatedEvent.description = event.description;
|
198
|
+
}
|
199
|
+
|
200
|
+
return generatedEvent;
|
201
|
+
};
|
202
|
+
|
203
|
+
const generateEvents = events => {
|
204
|
+
events = events.reduce((newEventsArray, event) => {
|
205
|
+
newEventsArray.push(generateSingleEvent(event));
|
206
|
+
|
207
|
+
return newEventsArray;
|
208
|
+
}, []);
|
209
|
+
|
210
|
+
return events;
|
211
|
+
};
|
212
|
+
|
213
|
+
const generateSingleSlot = slot => {
|
214
|
+
return {
|
215
|
+
deprecated: !!slot.deprecated,
|
216
|
+
description: slot.description,
|
217
|
+
name: slot.name,
|
218
|
+
};
|
219
|
+
};
|
220
|
+
|
221
|
+
const generateSlots = slots => {
|
222
|
+
slots = slots.reduce((newSlotsArray, event) => {
|
223
|
+
newSlotsArray.push(generateSingleSlot(event));
|
224
|
+
|
225
|
+
return newSlotsArray;
|
226
|
+
}, []);
|
227
|
+
|
228
|
+
return slots;
|
229
|
+
};
|
230
|
+
|
231
|
+
const generateCustomElementDeclaration = entity => {
|
232
|
+
let generatedCustomElementDeclaration = {
|
233
|
+
deprecated: !!entity.deprecated,
|
234
|
+
customElement: true,
|
235
|
+
kind: entity.basename,
|
236
|
+
name: entity.basename,
|
237
|
+
tagName: entity.tagname,
|
238
|
+
};
|
239
|
+
|
240
|
+
const slots = filterPublicApi(entity.slots);
|
241
|
+
const events = filterPublicApi(entity.events);
|
242
|
+
const classFields = filterPublicApi(entity.properties);
|
243
|
+
const classMethods = filterPublicApi(entity.methods);
|
244
|
+
const attributes = classFields.filter(property => {
|
245
|
+
return property.noattribute !== "true" && property.readonly !== "true" && !forbiddenAttributeTypes.includes(property.type.toLowerCase());
|
246
|
+
});
|
247
|
+
|
248
|
+
if (slots.length) {
|
249
|
+
generatedCustomElementDeclaration.slots = generateSlots(slots);
|
250
|
+
}
|
251
|
+
|
252
|
+
if (events.length) {
|
253
|
+
generatedCustomElementDeclaration.events = generateEvents(events);
|
254
|
+
}
|
255
|
+
|
256
|
+
if (attributes.length) {
|
257
|
+
generatedCustomElementDeclaration.attributes = generateAttributes(attributes);
|
258
|
+
}
|
259
|
+
|
260
|
+
if (entity.description) {
|
261
|
+
generatedCustomElementDeclaration.description = entity.description;
|
262
|
+
}
|
263
|
+
|
264
|
+
if (classFields.length || classMethods.length) {
|
265
|
+
generatedCustomElementDeclaration.members = generateMembers(classFields, classMethods);
|
266
|
+
}
|
267
|
+
|
268
|
+
if (entity.extends && entity.extends !== "HTMLElement") {
|
269
|
+
generatedCustomElementDeclaration.superclass = generateRefenrece(entity.extends);
|
270
|
+
}
|
271
|
+
|
272
|
+
return generatedCustomElementDeclaration;
|
273
|
+
};
|
274
|
+
|
275
|
+
const generateRefenrece = (entityName) => {
|
276
|
+
let packageName;
|
277
|
+
let basename;
|
278
|
+
|
279
|
+
if (!entityName) {
|
280
|
+
throw new Error("JSDoc error: entity not found in api.json.");
|
281
|
+
}
|
282
|
+
|
283
|
+
if (entityName.includes(".")) {
|
284
|
+
basename = entityName.split(".").pop();
|
285
|
+
} else {
|
286
|
+
basename = entityName
|
287
|
+
}
|
288
|
+
|
289
|
+
if (entityName.includes("sap.ui.webc.main")) {
|
290
|
+
packageName = "@ui5/webcomponents";
|
291
|
+
} else if (entityName.includes("sap.ui.webc.fiori")) {
|
292
|
+
packageName = "@ui5/webcomponents-fiori";
|
293
|
+
} else if (entityName.includes("sap.ui.webc.base")) {
|
294
|
+
packageName = "@ui5/webcomponents-base";
|
295
|
+
}
|
296
|
+
|
297
|
+
return {
|
298
|
+
module: `${basename}.js`,
|
299
|
+
name: `${basename}`,
|
300
|
+
package: packageName,
|
301
|
+
};
|
302
|
+
};
|
303
|
+
|
304
|
+
const filterPublicApi = array => {
|
305
|
+
return (array || []).filter(el => el.visibility === "public");
|
306
|
+
};
|
307
|
+
|
308
|
+
const generate = async () => {
|
309
|
+
const file = JSON.parse(await fs.readFile(path.join(inputDir, "api.json")));
|
310
|
+
let customElementsManifest = {
|
311
|
+
schemaVersion: "1.0.0",
|
312
|
+
readme: "",
|
313
|
+
modules: [],
|
314
|
+
};
|
315
|
+
|
316
|
+
file.symbols.forEach(entity => {
|
317
|
+
if (entity.tagname) {
|
318
|
+
customElementsManifest.modules.push(generateJavaScriptModule(entity));
|
319
|
+
}
|
320
|
+
});
|
321
|
+
|
322
|
+
await fs.writeFile(path.join(outputDir, "custom-elements.json"), JSON.stringify(customElementsManifest));
|
323
|
+
};
|
324
|
+
|
325
|
+
generate().then(() => {
|
326
|
+
console.log("Custom elements manifest generated.");
|
327
|
+
});
|
@@ -0,0 +1,72 @@
|
|
1
|
+
const fs = require("fs").promises;
|
2
|
+
const path = require('path');
|
3
|
+
|
4
|
+
const generate = async () => {
|
5
|
+
const fioriInputFolder = path.normalize(process.argv[2]);
|
6
|
+
const tntInputFolder = path.normalize(process.argv[3]);
|
7
|
+
const outputFile = path.normalize(`${process.argv[4]}/Illustrations.js`);
|
8
|
+
|
9
|
+
const dir = await fs.readdir(fioriInputFolder);
|
10
|
+
const fioriIllustrationsOnFileSystem = dir.map(illustrationName => {
|
11
|
+
const fioriMatches = illustrationName.match(/.*\.js$/);
|
12
|
+
return fioriMatches ? illustrationName : undefined;
|
13
|
+
}).filter(key => !!key);
|
14
|
+
|
15
|
+
const tntDir = await fs.readdir(tntInputFolder);
|
16
|
+
const tntIllustrationsOnFileSystem = tntDir.map(illustrationName => {
|
17
|
+
const tntMatches = illustrationName.match(/.*\.js$/);
|
18
|
+
return tntMatches ? illustrationName : undefined;
|
19
|
+
}).filter(key => !!key);
|
20
|
+
|
21
|
+
// dynamic imports for Fiori illustrations
|
22
|
+
const fioriAvailableIllustrationsArray = `[${fioriIllustrationsOnFileSystem.filter(
|
23
|
+
// skipping the items starting with sapIllus-Dialog, sapIllus-Scene, sapIllus-Spot since they are included in the illustration's js file
|
24
|
+
line => !line.startsWith("sapIllus-Dialog") && !line.startsWith("sapIllus-Scene") && !line.startsWith("sapIllus-Spot") && !line.startsWith("AllIllustrations")).map(illustrationName => `"${illustrationName.replace('.js', '')}"`).join(", ")}]`;
|
25
|
+
|
26
|
+
const fioriDynamicImportLines = fioriIllustrationsOnFileSystem.map(illustrationName =>
|
27
|
+
`\t\tcase "${illustrationName.replace('.js', '')}": return (await import("../../illustrations/${illustrationName}")).default;`).filter(
|
28
|
+
// skipping the items starting with sapIllus-Dialog, sapIllus-Scene, sapIllus-Spot since they are included in the illustration's js file
|
29
|
+
line => !line.startsWith("\t\tcase \"sapIllus-Dialog") && !line.startsWith("\t\tcase \"sapIllus-Scene") && !line.startsWith("\t\tcase \"sapIllus-Spot") && !line.startsWith("\t\tcase \"AllIllustrations")).join("\n");
|
30
|
+
|
31
|
+
// dynamic imports for Tnt illustrations
|
32
|
+
const tntAvailableIllustrationsArray = `[${tntIllustrationsOnFileSystem.filter(
|
33
|
+
// skipping the items starting with tnt-Dialog, tnt-Scene, tnt-Spot since they are included in the illustration's js file
|
34
|
+
line => !line.startsWith("tnt-Dialog") && !line.startsWith("tnt-Scene") && !line.startsWith("tnt-Spot")).map(illustrationName => `"Tnt${illustrationName.replace('.js', '')}"`).join(", ")}]`;
|
35
|
+
|
36
|
+
const tntDynamicImportLines = tntIllustrationsOnFileSystem.map(illustrationName =>
|
37
|
+
`\t\tcase "Tnt${illustrationName.replace('.js', '')}": return (await import("../../illustrations/tnt/${illustrationName}")).default;`).filter(
|
38
|
+
// skipping the items starting with tnt-Dialog, tnt-Scene, tnt-Spot since they are included in the illustration's js file
|
39
|
+
line => !line.startsWith("\t\tcase \"Tnttnt-Dialog") && !line.startsWith("\t\tcase \"Tnttnt-Scene") && !line.startsWith("\t\tcase \"Tnttnt-Spot")).join("\n");
|
40
|
+
|
41
|
+
|
42
|
+
// dynamic imports file content
|
43
|
+
const contentDynamic = `import { registerIllustrationLoader } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
|
44
|
+
|
45
|
+
const loadIllustration = async (illustrationName) => {
|
46
|
+
switch (illustrationName) {
|
47
|
+
${fioriDynamicImportLines}
|
48
|
+
${tntDynamicImportLines}
|
49
|
+
default: throw new Error("[Illustrations] Illustration not found: " + illustrationName);
|
50
|
+
}
|
51
|
+
};
|
52
|
+
const loadAndCheck = async (illustrationName) => {
|
53
|
+
const data = await loadIllustration(illustrationName);
|
54
|
+
return data;
|
55
|
+
}
|
56
|
+
|
57
|
+
|
58
|
+
${fioriAvailableIllustrationsArray}.forEach(illustrationName => registerIllustrationLoader(illustrationName, loadAndCheck));
|
59
|
+
${tntAvailableIllustrationsArray}.forEach(illustrationName => registerIllustrationLoader(illustrationName, loadAndCheck));`;
|
60
|
+
|
61
|
+
|
62
|
+
await fs.mkdir(path.dirname(outputFile), { recursive: true });
|
63
|
+
return Promise.all([fs.writeFile(outputFile, contentDynamic)]);
|
64
|
+
};
|
65
|
+
|
66
|
+
generate().then(() => {
|
67
|
+
console.log("Generated Illustrations.js");
|
68
|
+
})
|
69
|
+
.catch(err => {
|
70
|
+
console.error(err);
|
71
|
+
process.exit(1);
|
72
|
+
});
|
@@ -17,6 +17,14 @@ const hbs2lit = async (file) => {
|
|
17
17
|
|
18
18
|
sPreprocessed = removeWhiteSpaces(sPreprocessed);
|
19
19
|
|
20
|
+
// icons hack
|
21
|
+
if (sPreprocessed.startsWith("<g ") || sPreprocessed.startsWith("<g>")) {
|
22
|
+
return `
|
23
|
+
let block0 = () => {
|
24
|
+
return svg\`${sPreprocessed}\`
|
25
|
+
}`;
|
26
|
+
}
|
27
|
+
|
20
28
|
const ast = Handlebars.parse(sPreprocessed);
|
21
29
|
|
22
30
|
const pv = new PartialsVisitor();
|