babel-plugin-transform-modules-ui5 7.2.6 → 7.3.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [7.3.0](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/compare/v7.2.6...v7.3.0) (2024-01-18)
+
+
+### Bug Fixes
+
+* sanitize variable names for re-exports ([#122](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/issues/122)) ([f475dbc](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/commit/f475dbcb4f8b767a5680a974903e7f97df8dacc7))
+
+
+### Features
+
+* support using predefined controller extensions ([#120](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/issues/120)) ([d7cb66c](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/commit/d7cb66cd5af422529bb00658669e595af2477615))
+
+
+
+
+
 ## [7.2.6](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/compare/v7.2.5...v7.2.6) (2023-11-23)
 
 

package/dist/classes/helpers/classes.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.convertClassToUI5Extend = convertClassToUI5Extend;
 exports.getClassInfo = getClassInfo;
+exports.getTypeName = void 0;
 var _core = require("@babel/core");
 var _path = _interopRequireDefault(require("path"));
 var _objectAssignDefined = _interopRequireDefault(require("object-assign-defined"));
@@ -12,6 +13,7 @@ var th = _interopRequireWildcard(require("../../utils/templates"));
 var ast = _interopRequireWildcard(require("../../utils/ast"));
 var _jsdoc = require("./jsdoc");
 var _decorators = require("./decorators");
+var _imports = require("./imports");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -25,10 +27,11 @@ function _toPrimitive(input, hint) { if (typeof input !== "object" || input ===
  * Any static methods or properties will be moved outside the class body.
  * The path will be updated with the new AST.
  */
-function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, opts) {
+function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, importDeclarationPaths, opts) {
   if (!(_core.types.isClassDeclaration(node) || _core.types.isClassExpression(node))) {
     return node;
   }
+  const CONTROLLER_EXTENSION_TAG = "transformControllerExtension";
   const staticMembers = [];
   const classNameIdentifier = node.id;
   const className = classNameIdentifier.name;
@@ -51,7 +54,8 @@ function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, opts)
       extendProps.push(_core.types.objectProperty(_core.types.identifier(propName), extraStaticProps[propName]));
     }
   }
-  for (const member of node.body.body) {
+  for (const memberPath of path.get("body.body")) {
+    const member = memberPath.node;
     const memberName = member.key.name;
     if (_core.types.isClassMethod(member)) {
       var _member$params;
@@ -104,7 +108,47 @@ function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, opts)
         }
       }
     } else if (_core.types.isClassProperty(member)) {
-      if (!member.value) continue; // un-initialized static class prop (typescript)
+      var _member$leadingCommen, _member$decorators;
+      // For class properties annotated to represent controller extensions, replace the pure declaration with an assignment (that's what the runtime expects)
+      // and keep them at the initialization object as properties (don't move into constructor).
+      if ((_member$leadingCommen = member.leadingComments) !== null && _member$leadingCommen !== void 0 && _member$leadingCommen.some(comment => {
+        return comment.value.includes("@" + CONTROLLER_EXTENSION_TAG);
+      }) || (_member$decorators = member.decorators) !== null && _member$decorators !== void 0 && _member$decorators.some(decorator => {
+        var _decorator$expression;
+        return ((_decorator$expression = decorator.expression) === null || _decorator$expression === void 0 ? void 0 : _decorator$expression.name) === CONTROLLER_EXTENSION_TAG;
+      })) {
+        var _member$typeAnnotatio;
+        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)) {
+          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
+          const valueIdentifier = _core.types.identifier(typeName);
+          member.value = valueIdentifier;
+          member.typeAnnotation = null;
+          extendProps.unshift(buildObjectProperty(member)); // add it to the properties of the extend() config object
+
+          // 2. add a binding reference to the value, so in case the TS transpiler runs later it recognizes that the import is still needed
+          const typeNameFirstPart = typeName.split(".")[0]; // e.g. when "myExtension: someBundle.MyExtension"
+          if (memberPath.scope.hasBinding(typeNameFirstPart)) {
+            const binding = path.scope.getBinding(typeNameFirstPart);
+            binding.referencePaths.push(memberPath.get("value"));
+          }
+
+          // 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);
+          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
+            importDeclarationPaths[importDeclarationPaths.length - 1].insertAfter(neededImportDeclaration);
+          }
+
+          // 4. prevent the member from also being added to the constructor (member does have a value now and initializer would be added below)
+          continue;
+        }
+      }
+      if (!member.value) continue; // remove all other un-initialized static class props (typescript)
 
       // Special handling for TypeScript limitation where metadata, renderer and overrides must be properties.
       if (["metadata", "renderer", "overrides"].includes(memberName)) {
@@ -238,6 +282,33 @@ function getFileBaseNamespace(path, pluginOpts) {
     return undefined;
   }
 }
+const getQualifiedName = node => {
+  let {
+    left,
+    right
+  } = node;
+
+  // if left is TSQualifiedName, recursive call to get full namespace
+  if (_core.types.isTSQualifiedName(left)) {
+    left = getQualifiedName(left);
+  } else {
+    // if left is an Identifier
+    left = left.name;
+  }
+  return `${left}.${right.name}`;
+};
+const getTypeName = typeAnnotation => {
+  if (_core.types.isTSTypeReference(typeAnnotation)) {
+    // for TSTypeReference, typeName can be an Identifier or a TSQualifiedName
+    return typeAnnotation.typeName.name || getQualifiedName(typeAnnotation.typeName);
+  }
+  if (_core.types.isTSQualifiedName(typeAnnotation)) {
+    // for TSQualifiedName
+    return getQualifiedName(typeAnnotation);
+  }
+  return null;
+};
+exports.getTypeName = getTypeName;
 const buildObjectProperty = member => {
   const newObjectProperty = _core.types.objectProperty(member.key, member.value, member.computed);
   newObjectProperty.leadingComments = member.leadingComments;

package/dist/classes/helpers/imports.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getImportDeclaration = getImportDeclaration;
+exports.saveImports = void 0;
+var _core = require("@babel/core");
+let importDeclarations = {};
+const saveImports = file => {
+  // save all import declarations before "unneeded" ones are removed by the TypeScript plugin
+  importDeclarations[file.opts.filename] = file.ast.program.body.filter(_core.types.isImportDeclaration); // right now even the removed import still exists later and can be re-added. Otherwise do: .map(decl => t.cloneNode(decl));
+};
+
+// can be called from visitor to access previously present declarations
+exports.saveImports = saveImports;
+function getImportDeclaration(filename, typeName) {
+  const typeNameParts = typeName.split(".");
+
+  // find the declaration importing the typeName among the collected import declarations in this file
+  const filteredDeclarations = importDeclarations[filename].filter(importDeclaration => {
+    // each import declaration can import several entities, so let's check all of them
+    for (let specifier of importDeclaration.specifiers) {
+      if ((_core.types.isImportDefaultSpecifier(specifier) || _core.types.isImportNamespaceSpecifier(specifier)) && specifier.local.name === typeNameParts[0]) {
+        // if the import is default, then the typeName should only have one part (the import name)
+        return true;
+      } else if (_core.types.isImportSpecifier(specifier) && specifier.imported.name === typeNameParts[typeNameParts.length - 1]) {
+        // If the import is named, then the last part of the typeName should match the imported name
+        return true;
+      }
+    }
+  });
+  return filteredDeclarations[0]; // should be exactly one
+}

package/dist/classes/pre.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ClassPre = void 0;
+var _imports = require("./helpers/imports");
+const ClassPre = file => {
+  // save all import declarations before "unneeded" ones are removed by the TypeScript plugin
+  (0, _imports.saveImports)(file);
+};
+exports.ClassPre = ClassPre;

package/dist/classes/visitor.js

@@ -12,6 +12,9 @@ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 const CONSTRUCTOR = "constructor";
 const ClassTransformVisitor = exports.ClassTransformVisitor = {
+  ImportDeclaration(path) {
+    this.importDeclarationPaths.push(path);
+  },
   ImportDefaultSpecifier(path) {
     this.importNames.push(path.node.local.name);
   },
@@ -82,7 +85,7 @@ const ClassTransformVisitor = exports.ClassTransformVisitor = {
       const staticProps = ast.groupPropertiesByName(ast.getOtherPropertiesOfIdentifier(blockParent, className));
 
       // TODO: flag metadata and renderer for removal if applicable
-      const ui5ExtendClass = classes.convertClassToUI5Extend(path, node, classInfo, staticProps, opts);
+      const ui5ExtendClass = classes.convertClassToUI5Extend(path, node, classInfo, staticProps, this.importDeclarationPaths, opts);
       if (path.isClassDeclaration()) {
         if (_core.types.isExportDefaultDeclaration(parent)) {
           path.parentPath.replaceWithMultiple([...ui5ExtendClass, th.buildExportDefault({

package/dist/index.js

@@ -1,6 +1,7 @@
 "use strict";
 
 var _visitor = require("./classes/visitor");
+var _pre = require("./classes/pre");
 var _visitor2 = require("./modules/visitor");
 var _wrapper = require("./modules/helpers/wrapper");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
@@ -50,6 +51,7 @@ module.exports = () => {
 
         // Properties for Class Transform
         this.importNames = [];
+        this.importDeclarationPaths = [];
 
         // The classes must be converted right away before any other class transforms get a chance to run.
         path.traverse(_visitor.ClassTransformVisitor, this);
@@ -62,6 +64,7 @@ module.exports = () => {
     }
   }, _visitor2.ModuleTransformVisitor);
   return {
+    pre: _pre.ClassPre,
     visitor: UI5Visitor
   };
 };

package/dist/modules/visitor.js

@@ -18,8 +18,8 @@ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typ
 function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
-const tempModuleName = name => `__${name}`;
 const cleanImportSource = src => src.replace(/(\/)|(-)|(@)/g, "_").replace(/\./g, "");
+const tempModuleName = name => `__${name}`;
 const hasGlobalExportFlag = node => (0, _jsdoc.hasJsdocGlobalExportFlag)(node);
 const addModuleImport = (imports, name) => {
   const existingImport = imports.find(imp => imp.src === name);
@@ -269,7 +269,7 @@ const ModuleTransformVisitor = exports.ModuleTransformVisitor = {
   },
   ExportAllDeclaration(path) {
     const src = path.node.source.value;
-    const name = src.replace(/\//g, "_").replace(/\./g, "");
+    const name = cleanImportSource(src);
     const tmpName = tempModuleName(name);
     this.imports.push({
       src,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "babel-plugin-transform-modules-ui5",
-  "version": "7.2.6",
+  "version": "7.3.0",
   "description": "An unofficial babel plugin for SAP UI5.",
   "main": "dist/index.js",
   "repository": {
@@ -94,5 +94,5 @@
     "prettier": "^3.1.0",
     "rimraf": "^5.0.5"
   },
-  "gitHead": "915f8dba805bea185936ab5604fea135bd9c6740"
+  "gitHead": "cf41a67c81c9321ba93ce4299cbb33a908da4e1a"
 }