@ui5/webcomponents-tools 2.3.1-rc.0 → 2.4.0-rc.1

package/CHANGELOG.md

@@ -3,6 +3,34 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.4.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v2.4.0-rc.0...v2.4.0-rc.1) (2024-10-17)
+
+
+### Bug Fixes
+
+* scoping issues and document how scoping is used correctly ([#10023](https://github.com/SAP/ui5-webcomponents/issues/10023)) ([ee808c3](https://github.com/SAP/ui5-webcomponents/commit/ee808c309f316fe145b05d292c92328396c655ab))
+* **tools:** revert tsconfig moduleResolution to node ([#10014](https://github.com/SAP/ui5-webcomponents/issues/10014)) ([0724b92](https://github.com/SAP/ui5-webcomponents/commit/0724b9289ad04f88972d4978ed37e76f13abca13))
+
+
+
+
+
+# [2.4.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v2.3.1-rc.0...v2.4.0-rc.0) (2024-10-10)
+
+
+### Bug Fixes
+
+* require handlebar file names processed by hbs2ui5 tool to end with the '.hbs' extension ([#9992](https://github.com/SAP/ui5-webcomponents/issues/9992)) ([1b23f3d](https://github.com/SAP/ui5-webcomponents/commit/1b23f3d2b02829844cb8c0cd4a4adefd628b7f4f))
+
+
+### Features
+
+* enhance `[@event](https://github.com/event)` decorator ([#9944](https://github.com/SAP/ui5-webcomponents/issues/9944)) ([fe1d816](https://github.com/SAP/ui5-webcomponents/commit/fe1d816f512400b839fd4ce1b9af1506d0cb4c9a))
+
+
+
+
+
 ## [2.3.1-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v2.3.0...v2.3.1-rc.0) (2024-10-03)
 
 **Note:** Version bump only for package @ui5/webcomponents-tools

package/lib/cem/event.mjs

@@ -16,6 +16,7 @@ import {
 } from "./utils.mjs";
 
 const jsDocRegExp = /\/\*\*(.|\n)+?\s+\*\//;
+const ASTFalseKeywordCode = 94;
 
 const getParams = (ts, eventDetails, commentParams, classNode, moduleDoc) => {
 	return commentParams?.map(commentParam => {
@@ -77,17 +78,33 @@ function processEvent(ts, event, classNode, moduleDoc) {
 	const privacy = findTag(eventParsedComment, ["public", "private", "protected"])?.tag || "private";
 	const sinceTag = findTag(eventParsedComment, "since");
 	const commentParams = findAllTags(eventParsedComment, "param");
-	const allowPreventDefault = hasTag(eventParsedComment, "allowPreventDefault") || undefined;
 	const description = normalizeDescription(eventParsedComment?.description);
 	const native = hasTag(eventParsedComment, "native");
-	const eventDetails = event?.expression?.arguments?.[1]?.properties?.find(prop => prop?.name?.text === "detail")?.initializer?.properties;
+	const eventArgs =  event?.expression?.arguments;
+	let eventBubbles;
+	let eventCancelable;
+	let eventDetails;
+
+	eventArgs && eventArgs.forEach(arg => {
+		arg.properties?.forEach(prop => {
+			if (prop.name?.text === "bubbles") {
+				eventBubbles = prop.initializer.kind === ASTFalseKeywordCode ? false : true;
+			} else if (prop.name?.text === "cancelable") {
+				eventCancelable = prop.initializer.kind === ASTFalseKeywordCode ? false : true;
+			} else if (prop.name?.text === "detail") {
+				eventDetails = prop.initializer?.properties;
+			}
+		});
+	});
 
-	if (event?.expression?.arguments?.[1] && !event?.expression?.typeArguments) {
+	if (eventDetails && !event?.expression?.typeArguments) {
 		logDocumentationError(moduleDoc.path, `Event details for event '${name}' must be described using generics. Add type via generics to the decorator: @event<TypeForDetails>("${name}", {details}).`)
 	}
 
 	result.description = description;
-	result._ui5allowPreventDefault = allowPreventDefault;
+	result._ui5Cancelable = eventCancelable !== undefined ? eventCancelable : false;
+	result._ui5allowPreventDefault = result._ui5Cancelable;
+	result._ui5Bubbles = eventBubbles !== undefined ? eventBubbles : true;
 
 	if (native) {
 		result.type = { text: "Event" };

package/lib/cem/schema-internal.json

@@ -818,6 +818,14 @@
           "description": "Whether the parameter is optional. Undefined implies non-optional.",
           "type": "boolean"
         },
+        "_ui5Cancelable": {
+          "description": "Whether the event is cancelable or not.",
+          "type": "boolean"
+        },
+        "_ui5Bubbles": {
+          "description": "Whether the event bubbles or not.",
+          "type": "boolean"
+        },
         "_ui5since": {
           "description": "Marks when the field was introduced",
           "type": "string"

package/lib/cem/types-internal.d.ts

@@ -319,9 +319,20 @@ export interface Event {
   _ui5parameters?: Parameter[]
   _ui5privacy?: Privacy
   /**
-   * Whether the parameter is optional. Undefined implies non-optional.
+   * Whether the event is preventable.
+   */
+  _ui5allowPreventDefault?: boolean;
+
+  /**
+   * Whether the event is cancelable.
    */
-  _ui5allowPreventDefault?: boolean
+  _ui5Cancelable?: boolean;
+
+  /**
+   * Whether the event is bubbles.
+   */
+  _ui5Bubbles?: boolean;
+
   /**
    * Marks when the field was introduced
    */

package/lib/cem/utils.mjs

@@ -222,7 +222,7 @@ const commonTags = ["public", "protected", "private", "since", "deprecated"];
 const allowedTags = {
     field: [...commonTags, "formEvents", "formProperty", "default"],
     slot: [...commonTags, "default"],
-    event: [...commonTags, "param", "allowPreventDefault", "native"],
+    event: [...commonTags, "param", "native", "allowPreventDefault"],
     eventParam: [...commonTags],
     method: [...commonTags, "param", "returns", "override"],
     class: [...commonTags, "constructor", "class", "abstract", "experimental", "implements", "extends", "slot", "csspart"],
@@ -283,7 +283,7 @@ const findAllTags = (jsDoc, tagName) => {
 };
 
 const validateJSDocTag = (tag) => {
-    const booleanTags = ["private", "protected", "public", "abstract", "allowPreventDefault", "native", "formProperty", "constructor", "override"];
+    const booleanTags = ["private", "protected", "public", "abstract", "native", "allowPreventDefault", "formProperty", "constructor", "override"];
     let tagName = tag.tag;
 
     if (booleanTags.includes(tag.tag)) {

package/lib/hbs2ui5/index.js

@@ -24,7 +24,7 @@ const onError = (place) => {
 	console.log(`A problem occoured when reading ${place}. Please recheck passed parameters.`);
 };
 
-const isHandlebars = (fileName) => fileName.indexOf('.hbs') !== -1;
+const isHandlebars = (fileName) => fileName.endsWith('.hbs');
 
 const hasTypes = (file, componentName) => {
 	const tsFile = path.join(path.dirname(file), componentName + ".ts")

package/lib/scoping/get-all-tags.js

@@ -4,8 +4,15 @@ const glob = require("glob");
 
 const getTag = file => {
 	const fileContent = String(fs.readFileSync(file)).replace(/\n/g, "");
-	const matches = fileContent.match(/\btag\b:\s*\"(.*?)\"/);
-	return matches ? matches[1] : undefined;
+	let matches = fileContent.match(/\btag\b:\s*\"(.*?)\"/);
+	if (matches) {
+		return matches[1];
+	}
+	matches = fileContent.match(/@customElement\("(.*?)"\)/);
+	if (matches) {
+		return matches[1];
+	}
+	return undefined;
 };
 
 const getPackageTags = (packageDir) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ui5/webcomponents-tools",
-  "version": "2.3.1-rc.0",
+  "version": "2.4.0-rc.1",
   "description": "UI5 Web Components: webcomponents.tools",
   "author": "SAP SE (https://www.sap.com)",
   "license": "Apache-2.0",
@@ -86,5 +86,5 @@
     "esbuild": "^0.19.9",
     "yargs": "^17.5.1"
   },
-  "gitHead": "2857fcf8b4da8ccd7bbfa9dd0b0c2eb4c925cf4f"
+  "gitHead": "478542af62e30ca4df65b0778bcbeab837d583d6"
 }

package/tsconfig.json

@@ -1,6 +1,5 @@
 {
 	"compilerOptions": {
-		"module": "NodeNext",
 		"target": "ES2021",
 		"lib": [
 			"DOM",
@@ -12,5 +11,6 @@
 		"sourceMap": true,
 		"inlineSources": true,
 		"strict": true,
+		"moduleResolution": "node",
 	}
 }