babel-plugin-transform-modules-ui5 7.0.5 → 7.1.0

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [7.1.0](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/compare/v7.0.6...v7.1.0) (2023-03-13)
+
+
+### Features
+
+* backward compatibility for overrides (overridesToOverride option) ([dac96e6](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/commit/dac96e685548ccf831893c03e083e6db2dae3d4f))
+
+
+
+
+
+## [7.0.6](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/compare/v7.0.5...v7.0.6) (2023-02-21)
+
+**Note:** Version bump only for package babel-plugin-transform-modules-ui5

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ryan Murphy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/classes/helpers/classes.js

@@ -5,33 +5,21 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.convertClassToUI5Extend = convertClassToUI5Extend;
 exports.getClassInfo = getClassInfo;
-
 var _core = require("@babel/core");
-
 var _path = _interopRequireDefault(require("path"));
-
 var _objectAssignDefined = _interopRequireDefault(require("object-assign-defined"));
-
 var th = _interopRequireWildcard(require("../../utils/templates"));
-
 var ast = _interopRequireWildcard(require("../../utils/ast"));
-
 var _jsdoc = require("./jsdoc");
-
 var _decorators = require("./decorators");
-
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
-
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+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); }
 /**
  * Converts an ES6 class to a UI5 extend.
  * Any static methods or properties will be moved outside the class body.
@@ -41,12 +29,10 @@ function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, opts)
   if (!(_core.types.isClassDeclaration(node) || _core.types.isClassExpression(node))) {
     return node;
   }
-
   const staticMembers = [];
   const classNameIdentifier = node.id;
   const className = classNameIdentifier.name;
   const superClass = node.superClass; // Identifier node.
-
   const superClassName = superClass.name;
   const isController = className.includes("Controller") || !!classInfo.controller;
   const moveControllerConstructorToOnInit = isController && !!opts.moveControllerConstructorToOnInit;
@@ -59,27 +45,22 @@ function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, opts)
   const propsByName = {};
   let constructor;
   let constructorComments;
-  const staticPropsToAdd = moveStaticStaticPropsToExtend ? Object.keys(extraStaticProps) : ["metadata", "renderer"];
-
+  const staticPropsToAdd = moveStaticStaticPropsToExtend ? Object.keys(extraStaticProps) : ["metadata", "renderer", "overrides"];
   for (const propName of staticPropsToAdd) {
     if (extraStaticProps[propName]) {
       extendProps.push(_core.types.objectProperty(_core.types.identifier(propName), extraStaticProps[propName]));
     }
   }
-
   for (const member of node.body.body) {
     const memberName = member.key.name;
-
     if (_core.types.isClassMethod(member)) {
       const func = _core.types.functionExpression(member.key, member.params, member.body, member.generator, member.async);
-
       if (member.static) {
-        staticMembers.push(buildMemberAssignmentStatement(classNameIdentifier, _objectSpread({}, member, {
+        staticMembers.push(buildMemberAssignmentStatement(classNameIdentifier, _objectSpread(_objectSpread({}, member), {}, {
           value: func
         })));
       } else {
         propsByName[memberName] = func;
-
         if (member.kind === "get" || member.kind === "set") {
           extendProps.push(_core.types.objectMethod(member.kind, member.key, member.params, member.body, member.computed));
         } else {
@@ -87,15 +68,13 @@ function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, opts)
           if (memberName === CONSTRUCTOR) {
             constructorComments = member.leadingComments;
             constructor = func;
-
             if (moveControllerPropsToOnInit) {
               continue; // don't push to props yet
             }
           }
 
           func.id = path.scope.generateUidIdentifier(func.id.name); // Give the function a unique name
-
-          extendProps.push(buildObjectProperty(_objectSpread({}, member, {
+          extendProps.push(buildObjectProperty(_objectSpread(_objectSpread({}, member), {}, {
             value: func
           })));
         }
@@ -103,8 +82,11 @@ function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, opts)
     } else if (_core.types.isClassProperty(member)) {
       if (!member.value) continue; // un-initialized static class prop (typescript)
 
-      if (memberName === "metadata" || memberName === "renderer") {
-        // Special handling for TypeScript limitation where metadata and renderer must be properties.
+      // 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") {
+          member.key.name = "override";
+        }
         extendProps.unshift(buildObjectProperty(member));
       } else if (member.static) {
         if (moveStaticStaticPropsToExtend) {
@@ -114,11 +96,9 @@ function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, opts)
         }
       } else {
         propsByName[memberName] = member.value;
-
         if (memberName === "constructor") {
           constructorComments = member.leadingComments;
           constructor = member.value;
-
           if (moveControllerPropsToOnInit) {
             continue; // don't push to props yet
           }
@@ -131,24 +111,27 @@ function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, opts)
         }
       }
     }
-  } // Arrow function properties need to get moved to the constructor so that
+  }
+
+  // Arrow function properties need to get moved to the constructor so that
   // they're bound properly to the class instance, to align with the spec.
   // For controllers, use onInit rather than constructor, since controller constructors don't work.
   // Also move the constructor's statements to the onInit.
 
-
   const bindToConstructor = !moveControllerPropsToOnInit;
-  const bindToMethodName = moveControllerPropsToOnInit ? "onInit" : "constructor"; // avoid getting a prop named constructor as it may return {}'s
+  const bindToMethodName = moveControllerPropsToOnInit ? "onInit" : "constructor";
 
+  // avoid getting a prop named constructor as it may return {}'s
   let bindMethod = moveControllerPropsToOnInit ? propsByName[bindToMethodName] : constructor;
   const constructorJsdoc = (0, _jsdoc.getTags)(constructorComments);
-  const keepConstructor = !moveControllerConstructorToOnInit || classInfo.keepConstructor || constructorJsdoc.keep; // See if we need either constructor or onInit
+  const keepConstructor = !moveControllerConstructorToOnInit || classInfo.keepConstructor || constructorJsdoc.keep;
 
-  const needsBindingMethod = boundProps.length || moveControllerPropsToOnInit && constructor && !keepConstructor; // See if we need to create a new 'constructor' or 'onInit' method, depending which one we'll bind to.
+  // See if we need either constructor or onInit
+  const needsBindingMethod = boundProps.length || moveControllerPropsToOnInit && constructor && !keepConstructor;
 
+  // See if we need to create a new 'constructor' or 'onInit' method, depending which one we'll bind to.
   if (needsBindingMethod && !bindMethod) {
     const bindToId = _core.types.identifier(bindToMethodName);
-
     const bindMethodDeclaration = bindToConstructor ? th.buildInheritingConstructor({
       SUPER: _core.types.identifier(superClassName)
     }) : th.buildInheritingFunction({
@@ -158,7 +141,6 @@ function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, opts)
     bindMethod = ast.convertFunctionDeclarationToExpression(bindMethodDeclaration);
     extendProps.unshift(_core.types.objectProperty(bindToId, bindMethod));
   }
-
   if (constructor && moveControllerPropsToOnInit) {
     if (keepConstructor) {
       extendProps.unshift(_core.types.objectProperty(_core.types.identifier(CONSTRUCTOR), constructor));
@@ -167,13 +149,12 @@ function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, opts)
       bindMethod.body.body.unshift(...constructor.body.body.filter(node => !ast.isSuperCallExpression(node.expression)));
     }
   }
-
   if (boundProps.length) {
     // We need to inject the bound props into the bind method (constructor or onInit),
     // but not until after the super call (if applicable)
+
     const mappedProps = boundProps.map(member => buildThisMemberAssignmentStatement(member));
     const superIndex = bindMethod.body.body.findIndex(node => ast.isSuperCallExpression(node.expression) || ast.isSuperPrototypeCallOf(node.expression, superClassName, bindToMethodName));
-
     if (superIndex === -1) {
       // If there's no super, just add the bound props at the start
       bindMethod.body.body.unshift(...mappedProps);
@@ -183,7 +164,6 @@ function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, opts)
       bindMethod.body.body = [...upToSuper, ...mappedProps, ...afterSuper];
     }
   }
-
   const extendAssign = th.buildExtendAssign({
     NAME: classNameIdentifier,
     SUPER: superClass,
@@ -193,7 +173,6 @@ function convertClassToUI5Extend(path, node, classInfo, extraStaticProps, opts)
   });
   return [extendAssign, ...staticMembers];
 }
-
 function getFullyQualifiedName(classInfo) {
   if (classInfo.alias) return classInfo.alias;
   if (classInfo.name) return classInfo.name;
@@ -201,7 +180,6 @@ function getFullyQualifiedName(classInfo) {
   const separator = namespace ? "." : "";
   return `${namespace}${separator}${classInfo.localName}`;
 }
-
 function getClassInfo(path, node, parent, pluginOpts) {
   const defaults = {
     localName: node.id.name,
@@ -209,43 +187,33 @@ function getClassInfo(path, node, parent, pluginOpts) {
     fileNamespace: getFileBaseNamespace(path, pluginOpts) || ""
   };
   const decoratorInfo = (0, _decorators.getDecoratorClassInfo)(node);
-  const jsDocInfo = (0, _jsdoc.getJsDocClassInfo)(node, parent); // like Object.assign, but ignoring undefined values.
+  const jsDocInfo = (0, _jsdoc.getJsDocClassInfo)(node, parent);
 
+  // like Object.assign, but ignoring undefined values.
   return (0, _objectAssignDefined.default)(defaults, decoratorInfo, jsDocInfo);
 }
+
 /**
  * Reads the namespace from the file path (but not the name).
  */
-
-
 function getFileBaseNamespace(path, pluginOpts) {
   const opts = path.hub.file.opts;
-
   const filename = _path.default.resolve(opts.filename);
-
   const sourceRoot = opts.sourceRoot ? _path.default.resolve(process.cwd(), opts.sourceRoot) : process.cwd();
-
   if (filename.startsWith(sourceRoot)) {
     const filenameRelative = _path.default.relative(sourceRoot, filename);
-
     const {
       dir
     } = _path.default.parse(filenameRelative);
-
     const namespaceParts = dir.split(_path.default.sep);
-
     if (pluginOpts.namespacePrefix) {
       namespaceParts.unshift(pluginOpts.namespacePrefix);
     }
-
     return namespaceParts.join(".");
   } else {
     return undefined;
   }
 }
-
 const buildObjectProperty = member => _core.types.objectProperty(member.key, member.value, member.computed);
-
 const buildMemberAssignmentStatement = (objectIdentifier, member) => _core.types.expressionStatement(_core.types.assignmentExpression("=", _core.types.memberExpression(objectIdentifier, member.key, member.computed), member.value));
-
 const buildThisMemberAssignmentStatement = buildMemberAssignmentStatement.bind(null, _core.types.thisExpression());

package/dist/classes/helpers/decorators.js

@@ -6,36 +6,27 @@ Object.defineProperty(exports, "__esModule", {
 exports.getDecoratorClassInfo = getDecoratorClassInfo;
 const classInfoValueTags = ["alias", "name", "namespace", "metadata", "renderer"];
 const classInfoBoolTags = ["nonUI5"];
-
 function getDecoratorClassInfo(node) {
   const decorators = node.decorators;
-
   if (!decorators || !decorators.length) {
     return {};
   }
-
   const decoratorsByName = groupByName(decorators);
   const info = {};
-
   for (const tagName of classInfoValueTags) {
     const value = getDecoratorValue(decoratorsByName[tagName.toLowerCase()]);
-
     if (value) {
       info[tagName] = value;
     }
   }
-
   for (const tagName of classInfoBoolTags) {
     const value = !!decoratorsByName[tagName.toLowerCase()];
-
     if (value) {
       info[tagName] = value;
     }
   }
-
   return info;
 }
-
 function groupByName(decorators) {
   return decorators.reduce((accumulator, decorator) => {
     const expression = decorator.expression;
@@ -44,7 +35,6 @@ function groupByName(decorators) {
     return accumulator;
   }, {});
 }
-
 function getDecoratorValue(decorator) {
   return (decorator && decorator.expression.arguments[0] || {}).value;
 }

package/dist/classes/helpers/jsdoc.js

@@ -6,122 +6,97 @@ Object.defineProperty(exports, "__esModule", {
 exports.getJsDocClassInfo = getJsDocClassInfo;
 exports.getTags = getTags;
 exports.hasJsdocGlobalExportFlag = hasJsdocGlobalExportFlag;
-
 var _core = require("@babel/core");
-
 var _doctrine = _interopRequireDefault(require("doctrine"));
-
 var _ignoreCase = _interopRequireDefault(require("ignore-case"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const classInfoValueTags = ["alias", "name", "namespace"];
 const classInfoBoolTags = ["nonUI5", "controller", "keepConstructor"];
-
 function getJsDocClassInfo(node, parent) {
   if (node.leadingComments) {
     return node.leadingComments.filter(isCommentBlock).map(comment => {
       const docAST = _doctrine.default.parse(comment.value, {
         unwrap: true
       });
-
       const tags = docAST.tags || [];
       const info = {};
-
       for (const tagName of classInfoValueTags) {
         const value = getJsDocTagValue(tags, tagName);
-
         if (value) {
           info[tagName] = value;
         }
       }
-
       for (const tagName of classInfoBoolTags) {
         const value = !!getJsDocTag(tags, tagName);
-
         if (value) {
           info[tagName] = value;
         }
       }
-
       return info;
     }).filter(notEmpty)[0];
-  } // Else see if the JSDoc are on the return statement (eg. return class X extends SAPClass)
+  }
+  // Else see if the JSDoc are on the return statement (eg. return class X extends SAPClass)
   // or export statement (eg. export default class X extends SAPClass)
   else if (_core.types.isClassExpression(node) && _core.types.isReturnStatement(parent) || _core.types.isClassDeclaration(node) && _core.types.isExportDefaultDeclaration(parent)) {
-      return getJsDocClassInfo(parent);
-    } else {
-      return {};
-    }
+    return getJsDocClassInfo(parent);
+  } else {
+    return {};
+  }
 }
+
 /**
  * Returns a map of tags by name.
  * Converts empty to bool. Also converts bool value
  */
-
-
 function getTags(comments) {
   if (!comments) {
     return {};
   }
-
   for (const comment of comments) {
     if (!isCommentBlock(comment)) {
       continue;
     }
-
     const docAST = _doctrine.default.parse(comment.value, {
       unwrap: true
     });
-
     const tags = docAST.tags;
-
     if (!tags || !tags.length) {
       continue;
     }
-
     const map = {};
-
     for (const tag of tags) {
       const title = tag.title;
       let value = tag.name || tag.description || true;
       if (value === "false") value = false;
       map[title] = value;
     }
-
     return map;
   }
-
   return {};
 }
-
 function getJsDocTagValue(tags, name) {
   const tag = getJsDocTag(tags, name);
   return tag && (tag.name || tag.description);
 }
-
 function getJsDocTag(tags, name) {
   return tags.find(t => _ignoreCase.default.equals(name, t.title));
 }
-
 function notEmpty(obj) {
   return Object.values(obj).some(value => value);
 }
-
 function hasJsdocGlobalExportFlag(node) {
   if (!node.leadingComments) {
     return false;
   }
-
   return node.leadingComments.filter(isCommentBlock).some(comment => {
     return _doctrine.default.parse(comment.value, {
       unwrap: true,
       tags: ["global"]
     }).tags.length > 0;
   });
-} // This doesn't exist on babel-types
-
+}
 
+// This doesn't exist on babel-types
 function isCommentBlock(node) {
   return node && node.type === "CommentBlock";
 }