@ui5/create-webcomponents-package 0.0.0-354b6d238 → 0.0.0-3790e6927

package/CHANGELOG.md

@@ -3,6 +3,58 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.14.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v1.14.0-rc.0...v1.14.0-rc.1) (2023-05-25)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [1.14.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.13.2...v1.14.0-rc.0) (2023-05-18)
+
+
+### Features
+
+* users can provide a JSDoc namespeace when creating a package ([#7034](https://github.com/SAP/ui5-webcomponents/issues/7034)) ([0af8d23](https://github.com/SAP/ui5-webcomponents/commit/0af8d2376e25e5abe6d940c72286ab7c682eea56))
+
+
+
+
+
+## [1.13.1](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.5...v1.13.1) (2023-05-11)
+
+
+### Bug Fixes
+
+* **create-package:** revert  `moduleResolution` setting to `node` ([#7020](https://github.com/SAP/ui5-webcomponents/issues/7020)) ([9fc84e2](https://github.com/SAP/ui5-webcomponents/commit/9fc84e288452616ee72f3a2b6fc31d9752f05f6f))
+
+
+
+
+
+# [1.13.0-rc.5](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.4...v1.13.0-rc.5) (2023-05-11)
+
+
+### Bug Fixes
+
+* **create-webcomponents-package:** fix package creation issues with test and lint ([#6976](https://github.com/SAP/ui5-webcomponents/issues/6976)) ([dd70f3a](https://github.com/SAP/ui5-webcomponents/commit/dd70f3aa8ef70b592f1d4e0f3f9894c6280fb1bf))
+
+
+
+
+
+# [1.13.0-rc.4](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.3...v1.13.0-rc.4) (2023-05-04)
+
+
+### Features
+
+* generate TS from HBS templates ([#6558](https://github.com/SAP/ui5-webcomponents/issues/6558)) ([02611b2](https://github.com/SAP/ui5-webcomponents/commit/02611b2e24b2c2a06129b8e60a8bc680d9501e39))
+
+
+
+
+
 # [1.13.0-rc.3](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.2...v1.13.0-rc.3) (2023-04-27)
 
 **Note:** Version bump only for package @ui5/create-webcomponents-package

package/create-package.js

@@ -16,13 +16,6 @@ const version = JSON.parse(fs.readFileSync(path.join(__dirname, "package.json"))
 const TEMPLATE_DIR = path.join(`${__dirname}`, `template/`);
 
 // String utils
-const capitalizeFirst = str => str.substr(0,1).toUpperCase() + str.substr(1);
-const kebabToCamelCase = string => toCamelCase(string.split("-"));
-const toCamelCase = parts => {
-	return parts.map((string, index) => {
-		return index === 0 ? string.toLowerCase() : string.charAt(0).toUpperCase() + string.slice(1).toLowerCase();
-	}).join("");
-};
 const isTSRelatedFile = sourcePath => {
 	return ["Assets.ts", "MyFirstComponent.ts", "tsconfig.json", "global.d.ts"].some(fileName => sourcePath.includes(fileName));
 };
@@ -32,14 +25,19 @@ const isJSRelatedFile = sourcePath => {
 const isGitIgnore = sourcePath => {
 	return sourcePath.includes("gitignore");
 };
+const isLogo = sourcePath => {
+	return sourcePath.includes("logo");
+};
 const isNPMRC = sourcePath => {
 	return sourcePath.includes("npmrc");
 };
 
 // Validation of user input
 const ComponentNamePattern = /^[A-Z][A-Za-z0-9]+$/;
-const isNameValid = name => typeof name === "string" && name.match(/^[a-zA-Z][a-zA-Z0-9\-_]+$/);
+const NamespacePattern = /^[a-z][a-z0-9\.\-]+$/;
+const isPackageNameValid = name => typeof name === "string" && name.match(/^(@[a-z0-9-~][a-z0-9-._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/);
 const isComponentNameValid = name => typeof name === "string" && ComponentNamePattern.test(name);
+const isNamespaceValid = name => typeof name === "string" && NamespacePattern.test(name);
 const isTagValid = tag => typeof tag === "string" && tag.match(/^[a-z0-9]+?-[a-zA-Z0-9\-_]+?[a-z0-9]$/);
 
 /**
@@ -74,6 +72,11 @@ const copyFile = (vars, sourcePath, destPath) => {
 		return;
 	}
 
+	if (isLogo()) {
+		fs.copyFileSync(sourcePath, destPath);
+		return;
+	}
+
 	let content = fs.readFileSync(sourcePath, { encoding: "UTF-8" });
 	content = replaceVarsInFileContent(vars, content);
 	destPath = replaceVarsInFileName(vars, destPath);
@@ -105,19 +108,20 @@ const copyFiles = (vars, sourcePath, destPath) => {
 	}
 };
 
-const generateFilesContent = (name, componentName, typescript, skipSubfolder) => {
+const generateFilesContent = (packageName, componentName, namespace, typescript, skipSubfolder) => {
 	const tagName = argv.tag || hyphaneteComponentName(componentName);
 
 	// All variables that will be replaced in the content of the resources/
 	const vars = {
-		INIT_PACKAGE_VAR_NAME: name,
+		INIT_PACKAGE_VAR_NAMESPACE: namespace, // namespace must be replaced before name
+		INIT_PACKAGE_VAR_NAME: packageName,
 		INIT_PACKAGE_VAR_TAG: tagName,
 		INIT_PACKAGE_VAR_CLASS_NAME: componentName,
 		INIT_PACKAGE_VAR_TYPESCRIPT: typescript,
 	};
 
 	const packageContent = {
-		name,
+		name: packageName,
 		version: "0.0.1",
 		ui5: {
 			webComponentsPackage: true,
@@ -154,14 +158,16 @@ const generateFilesContent = (name, componentName, typescript, skipSubfolder) =>
 	}
 
 	// Update package.json
-	const destDir = skipSubfolder ? path.join("./") : path.join("./", name);
+	let destDir = packageName.includes("@") ? packageName.slice(packageName.lastIndexOf("/") + 1) : packageName;
+
+	destDir = skipSubfolder ? path.join("./") : path.join("./", destDir);
 	mkdirp.sync(destDir);
 	fs.writeFileSync(path.join(destDir, "package.json"), JSON.stringify(packageContent, null, 2));
 	// Copy files
 	copyFiles(vars, TEMPLATE_DIR, destDir);
 
 	console.log("\nPackage successfully created!\nNext steps:\n");
-	console.log(`$ cd ${name}`);
+	console.log(`$ cd ${destDir}`);
 
 	let userAgentInfo;
 	try {
@@ -182,7 +188,7 @@ const generateFilesContent = (name, componentName, typescript, skipSubfolder) =>
 // Main function
 const createWebcomponentsPackage = async () => {
 	let response;
-	if (argv.name && !isNameValid(argv.name)) {
+	if (argv.name && !isPackageNameValid(argv.name)) {
 		throw new Error("The package name should be a string, starting with letter and containing the following symbols [a-z, A-Z, 0-9].");
 	}
 
@@ -190,17 +196,22 @@ const createWebcomponentsPackage = async () => {
 		throw new Error("The component name should be a string, starting with a capital letter [A-Z][a-z], for example: Button, MyButton, etc.");
 	}
 
+	if (argv.namespace && !isNamespaceValid(argv.namespace)) {
+		throw new Error("The JSDoc namespace must start with a letter and can only contain small-case letters, numbers, dots and dashes.");
+	}
+
 	if (argv.tag && !isTagValid(argv.tag) ) {
 		throw new Error("The tag should be in kebab-case (f.e my-component) and it can't be a single word.");
 	}
 
-	let name = argv.name || "my-package";
+	let packageName = argv.name || "my-package";
 	let componentName = argv.componentName || "MyComponent";
+	let namespace = argv.namespace || "demo.components";
 	let typescriptSupport = !!argv.enableTypescript;
 	const skipSubfolder = !!argv.skipSubfolder;
 
 	if (argv.skip) {
-		return generateFilesContent(name, componentName, typescriptSupport, skipSubfolder);
+		return generateFilesContent(packageName, componentName, namespace, typescriptSupport, skipSubfolder);
 	}
 
 	if (!argv.name) {
@@ -208,9 +219,9 @@ const createWebcomponentsPackage = async () => {
 			type: "text",
 			name: "name",
 			message: "Package name:",
-			validate: (value) => isNameValid(value) ? true : "Package name should be a string, starting with a letter and containing the following symbols [a-z, A-Z ,0-9, _, -].",
+			validate: (value) => isPackageNameValid(value) ? true : "Package name should be a string, starting with a letter and containing the following symbols [a-z, A-Z ,0-9, _, -].",
 		});
-		name = response.name;
+		packageName = response.name;
 	}
 
 	if (!typescriptSupport) {
@@ -243,7 +254,18 @@ const createWebcomponentsPackage = async () => {
 		componentName = response.componentName;
 	}
 
-	return generateFilesContent(name, componentName, typescriptSupport, skipSubfolder);
+	if (!argv.namespace) {
+		response = await prompts({
+			type: "text",
+			name: "namespace",
+			message: "JSDoc namespace:",
+			initial: "demo.components",
+			validate: (value) => isNamespaceValid(value) ? true : "The JSDoc namespace must start with a letter and can only contain small-case letters, numbers, dots and dashes.",
+		});
+		namespace = response.namespace;
+	}
+
+	return generateFilesContent(packageName, componentName, namespace, typescriptSupport, skipSubfolder);
 };
 
 createWebcomponentsPackage();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ui5/create-webcomponents-package",
-  "version": "0.0.0-354b6d238",
+  "version": "0.0.0-3790e6927",
   "description": "UI5 Web Components: create package",
   "author": "SAP SE (https://www.sap.com)",
   "license": "Apache-2.0",

package/template/config/vite.config.js

@@ -0,0 +1,4 @@
+// vite.config.js
+const config = require("@ui5/webcomponents-tools/components-package/vite.config.js"); // eslint-disable-line
+config.server = { open: "/test/pages/index.html" };
+module.exports = config;

package/template/src/MyFirstComponent.hbs

@@ -1 +1 @@
-<div>This is: INIT_PACKAGE_VAR_TAG. {{pleaseWaitText}}</div>
+<div @click="{{onClick}}">{{counterText}} :: {{counter}}</div>

package/template/src/MyFirstComponent.js

@@ -8,14 +8,23 @@ import INIT_PACKAGE_VAR_CLASS_NAMETemplate from "./generated/templates/INIT_PACK
 // Styles
 import INIT_PACKAGE_VAR_CLASS_NAMECss from "./generated/themes/INIT_PACKAGE_VAR_CLASS_NAME.css.js";
 
-import { PLEASE_WAIT } from "./generated/i18n/i18n-defaults.js";
+import { COUNTER } from "./generated/i18n/i18n-defaults.js";
 
 /**
  * @public
  */
 const metadata = {
 	tag: "INIT_PACKAGE_VAR_TAG",
-	properties: {
+	properties: /** @lends INIT_PACKAGE_VAR_NAMESPACE.INIT_PACKAGE_VAR_CLASS_NAME.prototype */ {
+		/**
+		 * Defines the counter of the component.
+		 * @type { number }
+		 * @defaultvalue 0
+		 * @public
+		 */
+		counter: {
+			defaultValue: 0,
+		},
 	},
 	slots: {
 	},
@@ -31,7 +40,7 @@ const metadata = {
  * The <code>INIT_PACKAGE_VAR_TAG</code> component is a demo component that displays some text.
  *
  * @constructor
- * @alias demo.components.INIT_PACKAGE_VAR_CLASS_NAME
+ * @alias INIT_PACKAGE_VAR_NAMESPACE.INIT_PACKAGE_VAR_CLASS_NAME
  * @extends sap.ui.webc.base.UI5Element
  * @tagname INIT_PACKAGE_VAR_TAG
  * @public
@@ -57,8 +66,12 @@ class INIT_PACKAGE_VAR_CLASS_NAME extends UI5Element {
 		INIT_PACKAGE_VAR_CLASS_NAME.i18nBundle = await getI18nBundle("INIT_PACKAGE_VAR_NAME");
 	}
 
-	get pleaseWaitText() {
-		return INIT_PACKAGE_VAR_CLASS_NAME.i18nBundle.getText(PLEASE_WAIT);
+	onClick() {
+		this.counter++;
+	}
+
+	get counterText() {
+		return INIT_PACKAGE_VAR_CLASS_NAME.i18nBundle.getText(COUNTER);
 	}
 }
 

package/template/src/MyFirstComponent.ts

@@ -1,5 +1,6 @@
 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 litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
 import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
 import type I18nBundle from "@ui5/webcomponents-base/dist/i18nBundle.js";
@@ -10,7 +11,7 @@ import INIT_PACKAGE_VAR_CLASS_NAMETemplate from "./generated/templates/INIT_PACK
 // Styles
 import INIT_PACKAGE_VAR_CLASS_NAMECss from "./generated/themes/INIT_PACKAGE_VAR_CLASS_NAME.css.js";
 
-import { PLEASE_WAIT } from "./generated/i18n/i18n-defaults.js";
+import { COUNTER } from "./generated/i18n/i18n-defaults.js";
 
 /**
  * @class
@@ -20,7 +21,7 @@ import { PLEASE_WAIT } from "./generated/i18n/i18n-defaults.js";
  * The <code>INIT_PACKAGE_VAR_TAG</code> component is a demo component that displays some text.
  *
  * @constructor
- * @alias demo.components.INIT_PACKAGE_VAR_CLASS_NAME
+ * @alias INIT_PACKAGE_VAR_NAMESPACE.INIT_PACKAGE_VAR_CLASS_NAME
  * @extends sap.ui.webc.base.UI5Element
  * @tagname INIT_PACKAGE_VAR_TAG
  * @public
@@ -38,8 +39,21 @@ class INIT_PACKAGE_VAR_CLASS_NAME extends UI5Element {
 		INIT_PACKAGE_VAR_CLASS_NAME.i18nBundle = await getI18nBundle("INIT_PACKAGE_VAR_NAME");
 	}
 
-	get pleaseWaitText() {
-		return INIT_PACKAGE_VAR_CLASS_NAME.i18nBundle.getText(PLEASE_WAIT);
+	/**
+	 * Defines the component counter.
+	 * @name NIT_PACKAGE_VAR_NAMESPACE.INIT_PACKAGE_VAR_CLASS_NAME.prototype.counter
+	 * @public
+	 * @type { number }
+	 */
+	@property({ defaultValue: 0 })
+	counter!: number;
+
+	onClick() {
+		this.counter++;
+	}
+
+	get counterText() {
+		return INIT_PACKAGE_VAR_CLASS_NAME.i18nBundle.getText(COUNTER);
 	}
 }
 

package/template/src/i18n/messagebundle.properties

@@ -1,2 +1,3 @@
-#please wait text for the sample component
-PLEASE_WAIT=wait
+# the "counter" text for the sample component
+COUNTER=Counter
+

package/template/src/i18n/messagebundle_de.properties

@@ -1 +1 @@
-PLEASE_WAIT=Bitte warten
+COUNTER=Schalter

package/template/src/i18n/messagebundle_en.properties

@@ -1 +1 @@
-PLEASE_WAIT=Please wait
+COUNTER=Counter

package/template/src/i18n/messagebundle_es.properties

@@ -1 +1 @@
-PLEASE_WAIT=Espere
+COUNTER=Encimera

package/template/src/i18n/messagebundle_fr.properties

@@ -1 +1 @@
-PLEASE_WAIT=Patientez.
+COUNTER=Comptoir

package/template/src/themes/MyFirstComponent.css

@@ -1,11 +1,12 @@
 :host {
-    border: 2px solid var(--my-component-border-color);
-    background-color: var(--sapBackgroundColor);
-    color: var(--sapTextColor);
-    display: block;
-    width: 24rem;
-    height: 3rem;
-    text-align: center;
-    vertical-align: middle;
-    line-height: 3rem;
+	padding: 0 2rem;
+	color: var(--sapAvatar_6_TextColor);
+	background-color: var(--sapAvatar_6_Background);
+	border: 2px solid var(--my-component-border-color);
+	border-radius: 0.5rem;
+	box-shadow: var(--sapContent_Shadow0);
+	text-align: center;
+	line-height: 3rem;
+	font-size: 1.25rem;
+	user-select: none;
 }

package/template/src/themes/sap_fiori_3/parameters-bundle.css

@@ -1,3 +1,3 @@
 :root {
-    --my-component-border-color: green;
+    --my-component-border-color: blue;
 }

package/template/src/themes/sap_horizon_dark/parameters-bundle.css

@@ -1,3 +1,3 @@
 :root {
-    --my-component-border-color: blue;
+    --my-component-border-color: darkblue;
 }

package/template/test/pages/css/index.css

@@ -0,0 +1,36 @@
+body {
+	color: var(--sapTextColor);
+	background-color: var(--sapBackgroundColor);
+	font-size: var(--sapFontSize);
+	font-family: var(--sapFontFamily);
+}
+
+h1 {
+	font-size: var(--sapFontHeader2Size);
+	margin-bottom: 0.5rem;
+}
+
+h2 {
+	font-size: var(--sapFontHeader3Size);
+	margin-bottom: 0.5rem;
+}
+
+.app, .app-first-component, .app-settings, .app-docs  {
+	display: flex;
+	align-items: center;
+	justify-content: center;
+	flex-direction: column;
+}
+
+.app-first-component {
+	margin-bottom: 3rem;
+}
+
+.app-docs {
+	margin-top: 3rem;
+}
+
+a {
+	margin: 0.25rem;
+	color: var(--sapLinkColor);
+}

package/template/test/pages/index.html

@@ -10,44 +10,48 @@
 
 	<script data-ui5-config type="application/json">
 		{
+			"theme": "sap_horizon_dark",
 			"language": "EN"
 		}
 	</script>
-
+	
+	<link rel="stylesheet" type="text/css" href="./css/index.css">
 	<script src="../../bundle.esm.js" type="module"></script>
-
-    <style>
-        code { color: blue; font-size: small; }
-    </style>
-
 </head>
 
 <body>
-	<ul>
-	    <li><a href="?sap-ui-theme=sap_fiori_3">Fiori 3</a></li>
-		<li><a href="?sap-ui-theme=sap_fiori_3_dark">Fiori 3 Dark</a></li>
-		<li><a href="?sap-ui-theme=sap_fiori_3_hcb">Fiori 3 High Contrast Black</a></li>
-		<li><a href="?sap-ui-theme=sap_fiori_3_hcw">Fiori 3 High Contrast White</a></li>
-		<li><a href="?sap-ui-theme=sap_horizon">Horizon</a></li>
-		<li><a href="?sap-ui-theme=sap_horizon_dark">Horizon Dark</a></li>
-		<li><a href="?sap-ui-theme=sap_horizon_hcb">Horizon High Contrast Black</a></li>
-		<li><a href="?sap-ui-theme=sap_horizon_hcw">Horizon High Contrast White</a></li>
-	</ul>
-    <br>
-    <span>or in the browser console, for example:</span>
-    <code>window['sap-ui-webcomponents-bundle'].configuration.setTheme("sap_horizon_hcb")</code>
-
-    <br><br>
-
-    <a href="?sap-ui-language=en">English</a> |
-    <a href="?sap-ui-language=de">German</a> |
-    <a href="?sap-ui-language=es">Spanish</a> |
-    <a href="?sap-ui-language=fr">French</a>
-
-    <br><br>
-
-    <h1>Test your web components here</h1>
-    <INIT_PACKAGE_VAR_TAG id="myFirstComponent"></INIT_PACKAGE_VAR_TAG>
+	<div class="app">
+		<a href="https://sap.github.io/ui5-webcomponents/playground/getting-started" target="_blank"><img src="./img/logo.png" alt="logo"/></a>
+
+		<div class="app-first-component">
+			<h1>Hooray! It's Your First Web Component!</h1>
+			<div> <pre>&lt;INIT_PACKAGE_VAR_TAG>&lt;/INIT_PACKAGE_VAR_TAG> </pre></div>
+			<INIT_PACKAGE_VAR_TAG id="myFirstComponent"></INIT_PACKAGE_VAR_TAG>
+		</div>
+	
+		<div class="app-settings">
+
+			<h2>Switch themes</h2>
+			<div style="display: flex; flex-direction: row;">
+				<a class="link" href="?sap-ui-theme=sap_horizon">Horizon</a>
+				<a class="link" href="?sap-ui-theme=sap_horizon_dark">Horizon Dark</a>
+				<a class="link" href="?sap-ui-theme=sap_horizon_hcb">Horizon High Contrast Black</a>
+				<a class="link" href="?sap-ui-theme=sap_horizon_hcw">Horizon High Contrast White</a>
+			</div>
+		
+			<h2>Switch language</h2>
+			<div>
+				<a class="link" href="?sap-ui-language=en">English</a>
+				<a class="link" href="?sap-ui-language=de">German</a>
+				<a class="link" href="?sap-ui-language=es">Spanish</a>
+				<a class="link" href="?sap-ui-language=fr">French</a>
+			</div>
+		</div>
+
+		<div class="app-docs">
+			<h2>Documentation</h2>
+			<a class="link" href="https://sap.github.io/ui5-webcomponents/playground/development">Custom Component Development</a>
+		</div>
+	</div>
 </body>
-
 </html>

package/template/test/specs/Demo.spec.js

@@ -6,7 +6,6 @@ describe("INIT_PACKAGE_VAR_TAG rendering", async () => {
 	});
 
 	it("tests if web component is correctly rendered", async () => {
-
 		const innerContent = await browser.$("#myFirstComponent").shadow$("div");
 
 		assert.ok(innerContent, "content rendered");

package/template/global.d.ts

@@ -1,12 +0,0 @@
-// eslint-disable-next-line
-import "@ui5/webcomponents-base/dist/global";
-import { TemplateFunction } from "@ui5/webcomponents-base/dist/renderer/executeTemplate.js";
-
-export {};
-
-declare global {
-	module "*.lit.js" {
-		const content: TemplateFunction;
-		export default content;
-	}
-}

package/template/src/themes/sap_fiori_3_dark/parameters-bundle.css

@@ -1,3 +0,0 @@
-:root {
-    --my-component-border-color: blue;
-}

package/template/src/themes/sap_fiori_3_hcb/parameters-bundle.css

@@ -1,3 +0,0 @@
-:root {
-    --my-component-border-color: lightblue;
-}

package/template/src/themes/sap_fiori_3_hcw/parameters-bundle.css

@@ -1,3 +0,0 @@
-:root {
-    --my-component-border-color: gray;
-}