@ui5/webcomponents-tools 0.0.0-dcd8e5389 → 0.0.0-ddc5fe31b

package/lib/cem/utils.mjs

@@ -0,0 +1,379 @@
+import fs from "fs";
+import path from "path";
+
+let documentationErrors = new Map();
+
+const getDeprecatedStatus = (jsdocComment) => {
+    const deprecatedTag = findTag(jsdocComment, "deprecated");
+    return deprecatedTag?.name
+        ? deprecatedTag.description
+            ? `${deprecatedTag.name} ${deprecatedTag.description}`
+            : deprecatedTag.name
+        : deprecatedTag
+            ? true
+            : undefined;
+};
+
+const normalizeDescription = (description) => {
+	return typeof description === 'string' ? description.replaceAll(/^-\s+|^(\n)+|(\n)+$/g, ""): description;
+}
+
+const getTypeRefs = (ts, node, member) => {
+    const extractTypeRefs = (type) => {
+        if (type?.kind === ts.SyntaxKind.TypeReference) {
+            return type.typeArguments?.length
+                ? type.typeArguments.map((typeRef) => typeRef.typeName?.text)
+                : [type.typeName?.text];
+        } else if (type?.kind === ts.SyntaxKind.ArrayType) {
+            return [type.elementType?.typeName?.text];
+        } else if (type?.kind === ts.SyntaxKind.UnionType) {
+            return type.types
+                .map((type) => extractTypeRefs(type))
+                .flat(1);
+        } else if (type?.kind === ts.SyntaxKind.TemplateLiteralType) {
+            if (member?.type) {
+                member.type.text = member.type.text.replaceAll?.(/`|\${|}/g, "");
+            }
+
+            return type.templateSpans?.length
+                ? type.templateSpans.map((typeRef) => typeRef.type?.typeName?.text)
+                : [type.typeName?.text];
+        }
+    };
+
+    let typeRefs = extractTypeRefs(node.type) || node?.typeArguments?.map(n => extractTypeRefs(n)).flat(2);
+
+    if (typeRefs) {
+        typeRefs = typeRefs.filter((e) => !!e);
+    }
+
+    return typeRefs?.length ? typeRefs : undefined;
+};
+
+const getSinceStatus = (jsdocComment) => {
+    const sinceTag = findTag(jsdocComment, "since");
+    return sinceTag
+        ? sinceTag.description
+            ? `${sinceTag.name} ${sinceTag.description}`
+            : sinceTag.name
+        : undefined;
+};
+
+const getPrivacyStatus = (jsdocComment) => {
+    const privacyTag = findTag(jsdocComment, ["public", "private", "protected"]);
+    return privacyTag?.tag || "private";
+};
+
+const findPackageName = (ts, sourceFile, typeName) => {
+    const localStatements = [
+        ts.SyntaxKind.EnumDeclaration,
+        ts.SyntaxKind.InterfaceDeclaration,
+        ts.SyntaxKind.ClassDeclaration,
+        ts.SyntaxKind.TypeAliasDeclaration,
+    ];
+
+    const isLocalDeclared = sourceFile.statements.some(
+        (statement) =>
+            localStatements.includes(statement.kind) && statement?.name?.text === typeName
+    );
+
+    if (isLocalDeclared) {
+        return packageJSON?.name;
+    } else {
+        const importStatements = sourceFile.statements?.filter(
+            (statement) => statement.kind === ts.SyntaxKind.ImportDeclaration
+        );
+        const currentModuleSpecifier = importStatements.find((statement) => {
+            if (statement.importClause?.name?.text === typeName) {
+                return true;
+            }
+
+            return statement.importClause?.namedBindings?.elements?.some(
+                (element) => element.name?.text === typeName
+            );
+        })?.moduleSpecifier;
+
+        if (currentModuleSpecifier?.text?.startsWith(".")) {
+            return packageJSON?.name;
+        } else {
+            return Object.keys(packageJSON?.dependencies || {}).find(
+                (dependency) =>
+                    currentModuleSpecifier?.text?.startsWith(`${dependency}/`)
+            );
+        }
+    }
+};
+
+const findImportPath = (ts, sourceFile, typeName, modulePath) => {
+    const localStatements = [
+        ts.SyntaxKind.EnumDeclaration,
+        ts.SyntaxKind.InterfaceDeclaration,
+        ts.SyntaxKind.ClassDeclaration,
+        ts.SyntaxKind.TypeAliasDeclaration,
+    ];
+
+    const isLocalDeclared = sourceFile.statements.some(
+        (statement) =>
+            localStatements.includes(statement.kind) && statement?.name?.text === typeName
+    );
+
+    if (isLocalDeclared) {
+        return (
+            modulePath?.replace("src", "dist")?.replace(".ts", ".js") || undefined
+        );
+    } else {
+        const importStatements = sourceFile.statements?.filter(
+            (statement) => statement.kind === ts.SyntaxKind.ImportDeclaration
+        );
+        const currentModuleSpecifier = importStatements.find((statement) => {
+            if (statement.importClause?.name?.text === typeName) {
+                return true;
+            }
+
+            return statement.importClause?.namedBindings?.elements?.some(
+                (element) => element.name?.text === typeName
+            );
+        })?.moduleSpecifier;
+
+        if (currentModuleSpecifier?.text?.startsWith(".")) {
+            return (
+                path.join(path.dirname(modulePath), currentModuleSpecifier.text)
+                    ?.replace("src", "dist")?.replace(".ts", ".js") || undefined
+            );
+        } else {
+            const packageName = Object.keys(packageJSON?.dependencies || {}).find(
+                (dependency) =>
+                    currentModuleSpecifier?.text?.startsWith(dependency)
+            );
+            return currentModuleSpecifier?.text
+                ?.replace(`${packageName}/`, "") || undefined;
+        }
+    }
+};
+
+
+const isClass = text => {
+	return text.includes("@abstract") || text.includes("@class") || text.includes("@constructor");
+};
+
+const normalizeTagType = (type) => {
+	return type?.trim();
+}
+
+const packageJSON = JSON.parse(fs.readFileSync("./package.json"));
+
+const getReference = (ts, type, classNode, modulePath) => {
+    let sourceFile = classNode.parent;
+
+    while (sourceFile && sourceFile.kind !== ts.SyntaxKind.SourceFile) {
+        sourceFile = sourceFile.parent;
+    }
+
+    const typeName =
+        typeof type === "string"
+            ? normalizeTagType(type)
+            : type.class?.expression?.text ||
+            type.typeExpression?.type?.getText() ||
+            type.typeExpression?.type?.elementType?.typeName?.text;
+    const packageName = findPackageName(ts, sourceFile, typeName);
+    const importPath = findImportPath(
+        ts,
+        sourceFile,
+        typeName,
+        modulePath
+    )?.replace(`${packageName}/`, "");
+
+    return packageName && {
+        name: typeName,
+        package: packageName,
+        module: importPath,
+    };
+};
+
+const getType = (type) => {
+    const typeName = typeof type === "string" ? normalizeTagType(type) : type?.type;
+
+    const multiple =
+        typeName?.endsWith("[]") || typeName?.startsWith("Array<");
+    const name = multiple
+        ? typeName?.replace("[]", "")?.replace("Array<", "")?.replace(">", "")
+        : typeName;
+
+    return typeName ? { typeName: multiple ? `Array<${name}>` : typeName, name, multiple } : undefined;
+};
+
+const commonTags = ["public", "protected", "private", "since", "deprecated"];
+
+const allowedTags = {
+    field: [...commonTags, "formEvents", "formProperty", "default"],
+    slot: [...commonTags, "default"],
+    event: [...commonTags, "param", "allowPreventDefault", "native"],
+    eventParam: [...commonTags],
+    method: [...commonTags, "param", "returns", "override"],
+    class: [...commonTags, "constructor", "class", "abstract", "implements", "extends", "slot", "csspart"],
+    enum: [...commonTags],
+    enumMember: [...commonTags],
+    interface: [...commonTags],
+};
+allowedTags.getter = [...allowedTags.field, "override"]
+
+const tagMatchCallback = (tag, tagName) => {
+    const currentTagName = tag.tag;
+
+    return typeof tagName === "string"
+        ? currentTagName === tagName
+        : tagName.includes(currentTagName);
+};
+
+const findDecorator = (node, decoratorName) => {
+    return node?.decorators?.find(
+        (decorator) =>
+            decorator?.expression?.expression?.text === decoratorName
+    );
+};
+
+const findAllDecorators = (node, decoratorName) => {
+    return (
+        node?.decorators?.filter(
+            (decorator) =>
+                decorator?.expression?.expression?.text === decoratorName
+        ) || []
+    );
+};
+
+const hasTag = (jsDoc, tagName) => {
+    if (!jsDoc) {
+        return;
+    }
+
+    return jsDoc?.tags?.some((tag) => tagMatchCallback(tag, tagName));
+};
+
+const findTag = (jsDoc, tagName) => {
+    if (!jsDoc) {
+        return;
+    }
+
+    return jsDoc?.tags?.find((tag) => tagMatchCallback(tag, tagName));
+};
+
+const findAllTags = (jsDoc, tagName) => {
+    if (!jsDoc) {
+        return [];
+    }
+
+    const foundTags = jsDoc?.tags?.filter((tag) => tagMatchCallback(tag, tagName));
+
+    return foundTags || [];
+};
+
+const validateJSDocTag = (tag) => {
+    const booleanTags = ["private", "protected", "public", "abstract", "allowPreventDefault", "native", "formProperty", "constructor", "override"];
+    let tagName = tag.tag;
+
+    if (booleanTags.includes(tag.tag)) {
+        tagName = "boolean";
+    }
+
+    switch (tagName) {
+        case "boolean":
+            return !tag.name && !tag.type && !tag.description;
+        case "deprecated":
+            return !tag.type;
+        case "extends":
+            return !tag.type && tag.name && !tag.description;
+        case "implements":
+            return tag.type && !tag.name && !tag.description;
+        case "slot":
+            return tag.type && tag.name && tag.description;
+        case "csspart":
+            return !tag.type && tag.name && tag.description;
+        case "since":
+            return !tag.type && tag.name;
+        case "returns":
+            return !tag.type && tag.name;
+        case "default":
+            return !tag.type && !tag.description;
+        case "class":
+            return !tag.type;
+        case "param":
+            return !tag.type && tag.name;
+        case "eventparam":
+            return tag.type && tag.name;
+        case "formEvents":
+            return !tag.type && tag.name;
+        default:
+            return false;
+    }
+};
+
+const validateJSDocComment = (fieldType, jsdocComment, node, moduleDoc) => {
+    return !!jsdocComment?.tags?.every((tag) => {
+        let isValid = false
+
+        if (fieldType === "event" && tag?.tag === "param") {
+            isValid = allowedTags[fieldType]?.includes(tag.tag) && validateJSDocTag({...tag, tag: "eventparam"});
+        } else {
+            isValid = allowedTags[fieldType]?.includes(tag.tag) && validateJSDocTag(tag);
+        }
+
+        if (!isValid) {
+            logDocumentationError(moduleDoc.path, `Incorrect use of @${tag.tag}. Ensure it is part of ${fieldType} JSDoc tags.`)
+        }
+
+        return !!isValid;
+    });
+};
+
+const logDocumentationError = (modulePath, message) => {
+    let moduleErrors = documentationErrors.get(modulePath);
+
+    if (!moduleErrors) {
+        documentationErrors.set(modulePath, []);
+        moduleErrors = documentationErrors.get(modulePath);
+    }
+
+    moduleErrors.push(message);
+}
+
+const displayDocumentationErrors = () => {
+    let errorsCount = 0;
+    [...documentationErrors.keys()].forEach(modulePath => {
+        const moduleErrors = documentationErrors.get(modulePath);
+
+        console.log(`=== ERROR: ${moduleErrors.length > 1 ? `${moduleErrors.length} problems` :  "Problem"} found in file: ${modulePath}:`)
+        moduleErrors.forEach(moduleError => {
+            errorsCount++;
+            console.log(`\t- ${moduleError}`)
+        })
+    })
+
+    if(errorsCount) {
+        throw new Error(`Found ${errorsCount} errors in the description of the public API.`);
+    }
+}
+
+const formatArrays = (typeText) => {
+	return typeText?.replaceAll(/(\S+)\[\]/g, "Array<$1>")
+}
+
+export {
+    getPrivacyStatus,
+    getSinceStatus,
+    getDeprecatedStatus,
+    getType,
+    getReference,
+    validateJSDocComment,
+    findDecorator,
+    findAllDecorators,
+    hasTag,
+    findTag,
+    findAllTags,
+    getTypeRefs,
+    normalizeDescription,
+    formatArrays,
+    isClass,
+    normalizeTagType,
+    displayDocumentationErrors,
+    logDocumentationError,
+};

package/lib/cem/validate.js

@@ -0,0 +1,65 @@
+const fs = require('fs');
+const Ajv = require('ajv');
+const path = require('path');
+const yargs = require('yargs/yargs')
+const { hideBin } = require('yargs/helpers')
+const argv = yargs(hideBin(process.argv))
+	.argv;
+
+// Load your JSON schema
+const extenalSchema = require('./schema.json');
+const internalSchema = require('./schema-internal.json');
+
+// Load your JSON data from the input file
+const inputFilePath = path.join(process.cwd(), "dist/custom-elements.json"); // Update with your file path
+const customManifest = fs.readFileSync(inputFilePath, 'utf8');
+const inputDataInternal = JSON.parse(customManifest);
+
+const clearProps = (data) => {
+    if (Array.isArray(data)) {
+        for (let i = 0; i < data.length; i++) {
+            if (typeof data[i] === "object") {
+                if (["enum", "interface"].includes(data[i].kind)) {
+                    data.splice(i, 1);
+                    i--;
+                } else {
+                    clearProps(data[i]);
+                }
+            }
+        }
+    } else if (typeof data === "object") {
+        Object.keys(data).forEach(prop => {
+            if (prop.startsWith("_ui5")) {
+                delete data[prop];
+            } else if (typeof data[prop] === "object") {
+                clearProps(data[prop]);
+            }
+        });
+    }
+
+    return data;
+}
+
+const ajv = new Ajv({ allowUnionTypes: true, allError: true })
+let validate = ajv.compile(internalSchema)
+
+// Validate the JSON data against the schema
+if (argv.dev) {
+    if (validate(inputDataInternal)) {
+        console.log('Internal custom  element manifest is validated successfully');
+    } else {
+        throw new Error(`Validation of internal custom elements manifest failed: ${validate.errors}`);
+    }
+}
+
+const inputDataExternal = clearProps(JSON.parse(JSON.stringify(inputDataInternal)));
+validate = ajv.compile(extenalSchema)
+
+// Validate the JSON data against the schema
+if (validate(inputDataExternal)) {
+    console.log('Custom element manifest is validated successfully');
+    fs.writeFileSync(inputFilePath, JSON.stringify(inputDataExternal, null, 2), 'utf8');
+    fs.writeFileSync(inputFilePath.replace("custom-elements", "custom-elements-internal"), JSON.stringify(inputDataInternal, null, 2), 'utf8');
+} else if (argv.dev) {
+    throw new Error(`Validation of public custom elements manifest failed: ${validate.errors}`);
+    }

package/lib/create-illustrations/index.js

@@ -57,15 +57,25 @@ const generate = async () => {
 	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
+	// 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);
+	}
+
+	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);
 		fileName = fileName.replace(/\.svg$/, ".js");
 
@@ -84,54 +94,47 @@ const generate = async () => {
 
 		const illustrationNameUpperCase = illustrationNameForTranslation.toUpperCase();
 
-		return defaultText ? `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
+		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}";
+};`
+	};
 
-registerIllustration(name, {
-	dialogSvg,
-	sceneSvg,
-	spotSvg,
-	set,
-});
+	const illustrationTypeDefinition = illustrationName => {
+		return `declare const dialogSvg: string;
+declare const sceneSvg: string;
+declare const spotSvg: string;
+declare const _default: "${illustrationSet === "fiori" ? "" : `${illustrationSet}/`}${illustrationName}";
 
-export {
-	dialogSvg,
-	sceneSvg,
-	spotSvg,
-};`
+export default _default;
+export { dialogSvg, sceneSvg, spotSvg };`
 	};
 
 	await fs.mkdir(destPath, { recursive: true });
@@ -151,6 +154,7 @@ export {
 
 	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)));
 	}
 
 	return Promise.all(promises);

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

@@ -83,7 +83,7 @@ const generateFiles = (componentName, tagName, library, packageName, isTypeScrip
 	// 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 ${componentName} from "./dist/${componentName}.js";`);
+	import "./dist/${componentName}.js";`);
 }
 
 // Main function

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

@@ -25,10 +25,7 @@ import ${componentName}Css from "./generated/themes/${componentName}.css.js";
  * <code>import ${packageName}/dist/${componentName}.js";</code>
  *
  * @constructor
- * @author SAP SE
- * @alias sap.ui.webc.${library}.${componentName}
- * @extends sap.ui.webc.base.UI5Element
- * @tagname ${tagName}
+ * @extends UI5Element
  * @public
  */
 @customElement({
@@ -43,7 +40,6 @@ import ${componentName}Css from "./generated/themes/${componentName}.css.js";
  * Example custom event.
  * Please keep in mind that all public events should be documented in the API Reference as shown below.
  *
- * @event sap.ui.webc.${library}.${componentName}#interact
  * @public
  */
 @event("interact", { detail: { /* event payload ( optional ) */ } })
@@ -51,9 +47,7 @@ class ${componentName} extends UI5Element {
 	/**
 	 * Defines the value of the component.
 	 *
-	 * @type {string}
-	 * @name sap.ui.webc.${library}.${componentName}.prototype.value
-	 * @defaultvalue ""
+	 * @default ""
 	 * @public
 	 */
 	@property()
@@ -62,9 +56,6 @@ class ${componentName} extends UI5Element {
 	/**
 	 * Defines the text of the component.
 	 *
-	 * @type {Node[]}
-	 * @name sap.ui.webc.${library}.${componentName}.prototype.default
-	 * @slot
 	 * @public
 	 */
 	@slot({ type: Node, "default": true })

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);
+}