babel-plugin-transform-modules-ui5 7.4.2 → 7.6.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.6.0](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/compare/v7.5.0...v7.6.0) (2024-07-22)
+
+
+### Features
+
+* support sap.ui.require for [@sap](https://github.com/sap)UiRequire annotated modules ([#131](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/issues/131)) ([23c4ac6](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/commit/23c4ac67eef5a825692c528852ef62bbd621d13e))
+
+
+
+
+
+# [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)
 
 

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/helpers/wrapper.js

@@ -139,14 +139,19 @@ function wrap(visitor, programNode, opts) {
   if (imports.some(imp => imp.interop)) {
     body.unshift(th.buildDefaultImportInterop());
   }
-  const define = generateDefine(body, imports, exportGlobal || opts.exportAllGlobal, hasUseStrict(programNode));
+
+  // should we use sap.ui.require instead of sap.ui.define?
+  let useSapUiRequire = hasUseSapUiRequire(visitor.parent.comments, body, true);
+
+  // generate the sap.ui.define or sap.ui.require
+  const defineOrRequire = generateDefineOrRequire(body, imports, exportGlobal || opts.exportAllGlobal, useSapUiRequire);
 
   // add the "use strict" directive if not on program node
   if (!opts.neverUseStrict && !hasUseStrict(programNode)) {
-    const defineFnBody = define.expression.arguments[1].body;
-    defineFnBody.directives = [_core.types.directive(_core.types.directiveLiteral("use strict")), ...(defineFnBody.directives || [])];
+    const defineOrRequireFnBody = defineOrRequire.expression.arguments[1].body;
+    defineOrRequireFnBody.directives = [_core.types.directive(_core.types.directiveLiteral("use strict")), ...(defineOrRequireFnBody.directives || [])];
   }
-  programNode.body = [...preDefine, define];
+  programNode.body = [...preDefine, defineOrRequire];
 
   // if a copyright comment is present we append it to the new program node
   if (copyright && visitor.parent) {
@@ -157,11 +162,36 @@ function wrap(visitor, programNode, opts) {
 function hasUseStrict(node) {
   return (node.directives || []).some(directive => directive.value.value === "use strict");
 }
-function generateDefine(body, imports, exportGlobal) {
+function hasUseSapUiRequire(comments, body, remove) {
+  // detect the @sapUiRequire comment
+  return comments.some(comment => {
+    let found = false;
+    // check for existing comment block
+    if (comment.type === "CommentBlock") {
+      found = comment.value.trim() === "@sapUiRequire";
+    }
+    // remove the comment (if it is somewhere in the body)
+    if (found && remove) {
+      body === null || body === void 0 || body.forEach(node => {
+        (0, _core.traverse)(node, {
+          enter(path) {
+            ["leadingComments", "trailingComments", "innerComments"].forEach(key => {
+              var _path$node$key;
+              path.node[key] = (_path$node$key = path.node[key]) === null || _path$node$key === void 0 ? void 0 : _path$node$key.filter(c => c !== comment);
+            });
+          },
+          noScope: true
+        });
+      });
+    }
+    return found;
+  });
+}
+function generateDefineOrRequire(body, imports, exportGlobal, useRequire) {
   const defineOpts = {
     SOURCES: _core.types.arrayExpression(imports.map(i => _core.types.stringLiteral(i.src))),
     PARAMS: imports.map(i => _core.types.identifier(i.tmpName)),
     BODY: body
   };
-  return exportGlobal ? th.buildDefineGlobal(defineOpts) : th.buildDefine(defineOpts);
+  return useRequire ? th.buildRequire(defineOpts) : exportGlobal ? th.buildDefineGlobal(defineOpts) : th.buildDefine(defineOpts);
 }

package/dist/utils/templates.js

@@ -5,13 +5,18 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.buildInheritingFunction = exports.buildInheritingConstructor = exports.buildExtendAssign = exports.buildExportDefault = exports.buildDynamicImportHelper = exports.buildDefineGlobal = exports.buildDefine = exports.buildDefaultImportInterop = exports.buildDefaultImportDeconstructor = exports.buildDeclareExports = exports.buildConstDeclaration = exports.buildAssign = exports.buildAllExportHelper = exports.buildAllExport = void 0;
 exports.buildNamedExport = buildNamedExport;
-exports.exportsIdentifier = exports.buildTempExport = exports.buildReturnExports = exports.buildReturn = exports.buildNamedImportDestructor = void 0;
+exports.exportsIdentifier = exports.buildTempExport = exports.buildReturnExports = exports.buildReturn = exports.buildRequire = exports.buildNamedImportDestructor = void 0;
 var _core = require("@babel/core");
 const exportName = "__exports";
 const exportsIdentifier = exports.exportsIdentifier = _core.types.identifier(exportName);
 const buildAssign = exports.buildAssign = (0, _core.template)(`
   OBJECT.NAME = VALUE;
 `);
+const buildRequire = exports.buildRequire = (0, _core.template)(`
+  sap.ui.require(SOURCES, function (PARAMS) {
+    BODY;
+  });
+`);
 const buildDefine = exports.buildDefine = (0, _core.template)(`
   sap.ui.define(SOURCES, function (PARAMS) {
     BODY;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "babel-plugin-transform-modules-ui5",
-  "version": "7.4.2",
+  "version": "7.6.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": "840510e9de26aa1e17946cf0f3a2b6395089e7e1"
+  "gitHead": "8db5f32610df08996a49b97529c8a8f3fabcc59c"
 }