babel-plugin-transform-modules-ui5 7.4.1 → 7.5.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [7.5.0](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/compare/v7.4.2...v7.5.0) (2024-07-12)
+
+
+### Features
+
+* support ControllerExtensions extended with .override(...) ([#128](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/issues/128)) ([f744d9d](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/commit/f744d9db3dd82020712b47a18ce55ed51a13fe89))
+
+
+
+
+
+## [7.4.2](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/compare/v7.4.1...v7.4.2) (2024-06-25)
+
+
+### Bug Fixes
+
+* remove mandatory ESM file extensions from sap.ui.define imports ([#129](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/issues/129)) ([571dfa1](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/commit/571dfa192984c9838c573909546b42a85b71e5b6))
+
+
+
+
+
 ## [7.4.1](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/compare/v7.4.0...v7.4.1) (2024-06-02)
 
 

package/dist/classes/helpers/classes.js

@@ -121,6 +121,7 @@ function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, import
         const typeAnnotation = (_member$typeAnnotatio = member.typeAnnotation) === null || _member$typeAnnotatio === void 0 ? void 0 : _member$typeAnnotatio.typeAnnotation;
         // double-check that it is a valid node for a controller extension
         if (_core.types.isTSTypeReference(typeAnnotation) || _core.types.isTSQualifiedName(typeAnnotation)) {
+          var _memberPath$hub;
           const typeName = getTypeName(typeAnnotation);
 
           // 1. transform the property from being typed as instance and un-initialized to a property where the controller extension *class* is assigned as value
@@ -137,7 +138,7 @@ function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, import
           }
 
           // 3. restore the import in case it was run already and removed the import
-          const neededImportDeclaration = (0, _imports.getImportDeclaration)(memberPath.hub.file.opts.filename, typeName);
+          const neededImportDeclaration = (0, _imports.getImportDeclaration)(memberPath === null || memberPath === void 0 || (_memberPath$hub = memberPath.hub) === null || _memberPath$hub === void 0 || (_memberPath$hub = _memberPath$hub.file) === null || _memberPath$hub === void 0 || (_memberPath$hub = _memberPath$hub.opts) === null || _memberPath$hub === void 0 ? void 0 : _memberPath$hub.filename, typeName);
           if (!importDeclarationPaths.some(path => path.node === neededImportDeclaration)) {
             // TODO: import might be there but with the specifier removed; we can clone, but then other specifiers are duplicate
             // if import is no longer there, re-add it
@@ -150,6 +151,36 @@ function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, import
       }
       if (!member.value) continue; // remove all other un-initialized static class props (typescript)
 
+      // Now handle the case where an extended controller extension - not just e.g. "Routing", but
+      // "Routing.override({...})" - is assigned to the class property. To make this work in TypeScript code
+      // (Routing.override({...}) returns a class, but the "routing" member property needs to be typed as an instance),
+      // we require the following notation, using a dummy function ControllerExtension.use() that does actually
+      // not exist at runtime, but does the required class-to-instance conversion from TypeScript perspective:
+      //    routing: ControllerExtension.use(Routing.override({...}))
+      // In this case, the code in the "if" clause above was not executed, regardless of the presence of the
+      // @transformControllerExtension marker, because it is not a type assignment. In the resulting code, the
+      // "ControllerExtension.use(...)" part should be removed and the content of the brackets should be assigned
+      // directly to the member property.
+      if (_core.types.isCallExpression(member.value)) {
+        const callee = member.value.callee;
+        if (_core.types.isMemberExpression(callee) && _core.types.isIdentifier(callee.object) && _core.types.isIdentifier(callee.property) && callee.property.name === "use" // we are looking for "ControllerExtension.use(...)"
+        ) {
+          var _memberPath$hub2, _callee$object, _importDeclaration$so;
+          const importDeclaration = (0, _imports.getImportDeclaration)(memberPath === null || memberPath === void 0 || (_memberPath$hub2 = memberPath.hub) === null || _memberPath$hub2 === void 0 || (_memberPath$hub2 = _memberPath$hub2.file) === null || _memberPath$hub2 === void 0 || (_memberPath$hub2 = _memberPath$hub2.opts) === null || _memberPath$hub2 === void 0 ? void 0 : _memberPath$hub2.filename, callee === null || callee === void 0 || (_callee$object = callee.object) === null || _callee$object === void 0 ? void 0 : _callee$object.name // usually, but not necessarily always: "ControllerExtension"...
+          );
+          // ...hence we rather look at the imported module name to be sure
+          if ((importDeclaration === null || importDeclaration === void 0 || (_importDeclaration$so = importDeclaration.source) === null || _importDeclaration$so === void 0 ? void 0 : _importDeclaration$so.value) === "sap/ui/core/mvc/ControllerExtension") {
+            if (!member.value.arguments || member.value.arguments.length !== 1) {
+              // exactly one argument must be there
+              throw memberPath.buildCodeFrameError(`ControllerExtension.use() must be called with exactly one argument but has ${member.value.arguments ? member.value.arguments.length : 0}`);
+            }
+            member.value = member.value.arguments[0];
+            extendProps.unshift(buildObjectProperty(member)); // add it to the properties of the extend() config object
+            continue; // prevent the member from also being added to the constructor
+          }
+        }
+      }
+
       // Special handling for TypeScript limitation where metadata, renderer and overrides must be properties.
       if (["metadata", "renderer", "overrides"].includes(memberName)) {
         if (opts.overridesToOverride && member.key.name === "overrides") {

package/dist/classes/helpers/imports.js

@@ -15,6 +15,9 @@ const saveImports = file => {
 // can be called from visitor to access previously present declarations
 exports.saveImports = saveImports;
 function getImportDeclaration(filename, typeName) {
+  if (!filename || !typeName) {
+    return null;
+  }
   const typeNameParts = typeName.split(".");
 
   // find the declaration importing the typeName among the collected import declarations in this file

package/dist/modules/visitor.js

@@ -43,7 +43,23 @@ const addImport = (imports, imp, filename, first) => {
     // (the require/define of UI5 always adds the file extension ".js" to the module name)
     if (/^(?:(@[^/]+)\/)?([^/]+)\/(.*)\.js$/.test(imp.src)) {
       try {
-        const modulePath = require.resolve(imp.src);
+        let modulePath;
+        let absModuleSrc = imp.src;
+        // if the module has a relative path, resolve it to an absolute path
+        // and verify if the file exists, if not, try to resolve it as a module
+        if (/^\.\.?\//.test(absModuleSrc)) {
+          absModuleSrc = (0, _path.resolve)((0, _path.dirname)(filename), absModuleSrc);
+          // handle the fallback of module names introduced with Node 20.0.0
+          [".js", ".jsx", ".ts", ".tsx"].some(ext => {
+            if ((0, _fs.existsSync)(absModuleSrc.replace(/\.js$/, ext))) {
+              modulePath = imp.src;
+              return true;
+            }
+          });
+        } else {
+          modulePath = require.resolve(absModuleSrc);
+        }
+        // detect removal of file extension and log a hint
         if (modulePath.endsWith(imp.src.split("/").pop())) {
           console.log(`\x1b[33mHint:\x1b[0m Removed file extension for dependency "\x1b[34m${imp.src}\x1b[0m" found in \x1b[90m${filename}\x1b[0m`);
           imp.src = imp.src.slice(0, -3);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "babel-plugin-transform-modules-ui5",
-  "version": "7.4.1",
+  "version": "7.5.0",
   "description": "An unofficial babel plugin for SAP UI5.",
   "main": "dist/index.js",
   "repository": {
@@ -18,9 +18,9 @@
     "lint": "eslint src",
     "lint:fix": "npm run lint -- --fix",
     "lint:staged": "lint-staged",
-    "test": "jest __test__ --coverage=no",
+    "test": "FORCE_COLOR=0 jest __test__ --coverage=no",
     "test:watch": "npm test -- --watch",
-    "test:update-snapshot": "jest --updateSnapshot",
+    "test:update-snapshot": "FORCE_COLOR=0 jest --updateSnapshot",
     "prepare": "npm test && npm run build",
     "format": "prettier --write 'src/**/*.js'"
   },
@@ -94,5 +94,5 @@
     "prettier": "^3.1.0",
     "rimraf": "^5.0.5"
   },
-  "gitHead": "9c9165b630703bc760131df1277f258468c809ea"
+  "gitHead": "afd2f7c5644541c95ea3218a306fce1c71391050"
 }