@ui5/webcomponents-tools 2.15.0 → 2.16.0-rc.1

package/lib/cem/patch/@custom-elements-manifest/analyzer/src/utils/manifest-helpers.js

@@ -0,0 +1,194 @@
+/**
+ * UTILITIES RELATED TO GETTING INFORMATION OUT OF A MANIFEST OR DOC
+ */
+
+import { has } from "./index.js";
+
+/**
+ * @typedef {import('custom-elements-manifest/schema').Package} Package
+ */
+
+function loopThroughDeclarations(manifest, predicate) {
+  manifest?.modules?.forEach(_module => {
+    _module?.declarations?.forEach(predicate);
+  });
+}
+
+function loopThroughExports(manifest, predicate) {
+  manifest?.modules?.forEach(_module => {
+    _module?.exports?.forEach(predicate);
+  });
+}
+
+/**
+ * Loops through all modules' exports, and returns the kind provided by the users
+ *
+ * @example getKind('class');
+ * @example getKind('custom-element-definition');
+ */
+export function getAllExportsOfKind(manifest, kind) {
+  const result = [];
+  loopThroughExports(manifest, (_export) => {
+    if(_export.kind === kind) {
+      result.push(_export);
+    }
+  });
+  return result;
+}
+
+
+/**
+ * Loops through all modules' declarations, and returns the kind provided by the users
+ *
+ * @example getKind('class');
+ * @example getKind('custom-element-definition');
+ */
+export function getAllDeclarationsOfKind(manifest, kind) {
+  const result = [];
+  loopThroughDeclarations(manifest, (declaration) => {
+    if(declaration.kind === kind) {
+      result.push(declaration);
+    }
+  });
+  return result;
+}
+
+/**
+ * Gets the inheritance tree from a manifest given a className
+ * Returns an array of a classes mixins/superclasses all the way up the chain
+ *
+ * @param {Package[]} manifests
+ * @param {string} className
+ */
+export function getInheritanceTree(manifests, className) {
+  const tree = [];
+  const allClassLikes = new Map();
+  const _classes = [];
+  const _mixins = [];
+
+  manifests.forEach((cem) => {
+    _classes.push(...getAllDeclarationsOfKind(cem, 'class'));
+    _mixins.push(...getAllDeclarationsOfKind(cem, 'mixin'));
+  });
+
+  [..._mixins, ..._classes].forEach((klass) => {
+    allClassLikes.set(klass.name, klass);
+  });
+
+  let klass = allClassLikes.get(className)
+
+  if(klass) {
+    tree.push(klass)
+
+    klass?.mixins?.forEach(mixin => {
+      let foundMixin = _mixins.find(m => m.name === mixin.name);
+      if(foundMixin) {
+        tree.push(foundMixin);
+
+        while(has(foundMixin?.mixins)) {
+          foundMixin?.mixins?.forEach(mixin => {
+            foundMixin =  _mixins.find(m => m.name === mixin.name);
+            if(foundMixin) {
+              tree.push(foundMixin);
+            }
+          });
+        }
+      }
+    });
+
+    while(allClassLikes.has(klass.superclass?.name)) {
+      const newKlass = allClassLikes.get(klass.superclass.name);
+      let allMixins = [];
+      if (klass?.mixins) {
+        allMixins = [...klass.mixins];
+      }
+      if (newKlass?.mixins) {
+        allMixins = [...allMixins, ...newKlass.mixins];
+      }
+
+      allMixins.forEach(mixin => {
+        let foundMixin = _mixins.find(m => m.name === mixin.name);
+        if(foundMixin) {
+          tree.push(foundMixin);
+
+          while(has(foundMixin?.mixins)) {
+            foundMixin?.mixins?.forEach(mixin => {
+              foundMixin =  _mixins.find(m => m.name === mixin.name);
+              if(foundMixin) {
+                tree.push(foundMixin);
+              }
+            });
+          }
+        }
+      });
+
+      tree.push(newKlass);
+      klass = newKlass;
+    }
+    return tree;
+  }
+  return [];
+}
+
+/**
+ * @param {Package[]} manifests
+ * @param {string} modulePath
+ */
+ export function getModuleFromManifests(manifests, modulePath) {
+   let result = undefined;
+
+   manifests.forEach((cem) => {
+    cem?.modules?.forEach((_module) => {
+      if (_module.path === modulePath) {
+        result = _module;
+      }
+    });
+  });
+
+  return result;
+}
+
+/**
+ * @param {Package[]} manifests
+ * @param {string} className
+ */
+ export function getModuleForClassLike(manifests, className) {
+  let result = undefined;
+
+  manifests.forEach((cem) => {
+    cem?.modules?.forEach(_module => {
+      _module?.declarations?.forEach(declaration => {
+        if((declaration.kind === 'class' || declaration.kind === 'mixin') && declaration.name === className) {
+          result = _module.path;
+        }
+      });
+    });
+  });
+
+  return result;
+}
+
+/**
+ * Given a manifest module, a class name, and a class member name, gets the
+ * manifest doc for the module's class' member.
+ *
+ * @param  {Partial<import('custom-elements-manifest/schema').Module>} moduleDoc Manifest module
+ * @param  {string} className Class to get member of
+ * @param  {string} memberName Class member to get
+ * @param  {boolean} isStatic Is it a static member?
+ * @return {import('custom-elements-manifest/schema').ClassMember|void} the requested class member
+ */
+export function getClassMemberDoc(moduleDoc, className, memberName, isStatic = false) {
+  /** @type {import('custom-elements-manifest/schema').ClassDeclaration} */
+  const classDoc = (moduleDoc.declarations.find(x => x.name === className));
+
+  if (!classDoc || !has(classDoc.members))
+    return;
+
+  const memberDoc = classDoc.members.find(x =>
+    x.name === memberName &&
+    (x.static ?? false) === isStatic
+  );
+
+  return memberDoc;
+}

package/lib/cem/patch/@custom-elements-manifest/analyzer/src/utils/mixins.js

@@ -0,0 +1,112 @@
+import ts from 'typescript';
+
+import { getReturnValue } from '../utils/ast-helpers.js';
+
+export const isMixin = node => !!extractMixinNodes(node);
+
+export function extractMixinNodes(node) {
+  if (ts.isVariableStatement(node) || ts.isFunctionDeclaration(node)) {
+    if (ts.isVariableStatement(node)) {
+      /**
+       * @example const MyMixin = klass => class MyMixin extends klass {}
+       * @example export const MyMixin = klass => class MyMixin extends klass {}
+       */
+      const variableDeclaration = node.declarationList.declarations.find(declaration =>
+        ts.isVariableDeclaration(declaration),
+      );
+      if (variableDeclaration) {
+        const body = variableDeclaration?.initializer?.body;
+        if (body && ts.isClassExpression(body)) {
+          return { 
+            mixinFunction: node,
+            mixinClass: body,
+          };
+        }
+
+        /**
+         * @example const MyMixin = klass => { return class MyMixin extends Klass{} }
+         */
+        if (body && ts.isBlock(body)) {
+          const returnStatement = body.statements.find(statement => ts.isReturnStatement(statement));
+
+          if (returnStatement && returnStatement?.expression?.kind && ts.isClassExpression(returnStatement.expression)) {
+            return { 
+              mixinFunction: variableDeclaration.initializer,
+              mixinClass: returnStatement.expression
+            };
+          }
+        }
+
+        /**
+         * @example const MyMixin = klass => { class MyMixin extends klass {} return MyMixin;}
+         */
+        if (body && ts.isBlock(body)) {
+          const classDeclaration = body.statements.find(statement => ts.isClassDeclaration(statement));
+          const returnStatement = body.statements.find(statement => ts.isReturnStatement(statement));
+          /** Avoid undefined === undefined */
+          if(!(classDeclaration && returnStatement))
+            return;
+          const classDeclarationName = classDeclaration.name?.getText?.();
+          const returnValue = getReturnValue(returnStatement)
+          /**
+           * If the classDeclaration inside the function body has the same name as whats being
+           * returned from the function, consider it a mixin
+           */
+          if (classDeclarationName === returnValue) {
+            return {
+              mixinFunction: node,
+              mixinClass: classDeclaration
+            }
+          }
+        }
+      }
+    }
+
+    /**
+     *  @example function MyMixin(klass) { return class MyMixin extends Klass{} }
+     */
+    if (ts.isFunctionDeclaration(node)) {
+      if (node.body && ts.isBlock(node.body)) {
+
+        const returnStatement = node.body.statements.find(statement => ts.isReturnStatement(statement));
+
+        if (returnStatement?.expression && ts.isClassExpression(returnStatement.expression)) {
+          return { 
+            mixinFunction: node, 
+            mixinClass: returnStatement.expression
+          };
+        }
+      }
+    }
+
+    /**
+     * @example function MyMixin(klass) {class A extends klass {} return A;}
+     */
+    if (ts.isFunctionDeclaration(node)) {
+      if (node.body && ts.isBlock(node.body)) {
+        const classDeclaration = node.body.statements.find(statement => ts.isClassDeclaration(statement));
+        const returnStatement = node.body.statements.find(statement => ts.isReturnStatement(statement));
+
+        /** Avoid undefined === undefined */
+        if(!(classDeclaration && returnStatement))
+          return;
+
+        const classDeclarationName = classDeclaration.name?.getText?.();
+
+        const returnValue = getReturnValue(returnStatement)
+
+        /**
+         * If the classDeclaration inside the function body has the same name as whats being
+         * returned from the function, consider it a mixin
+         */
+        if (classDeclarationName === returnValue) {
+          return {
+            mixinFunction: node,
+            mixinClass: classDeclaration
+          }
+        }
+      }
+    }
+  }
+  return false;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ui5/webcomponents-tools",
-  "version": "2.15.0",
+  "version": "2.16.0-rc.1",
   "description": "UI5 Web Components: webcomponents.tools",
   "author": "SAP SE (https://www.sap.com)",
   "license": "Apache-2.0",
@@ -20,7 +20,7 @@
     "directory": "packages/tools"
   },
   "dependencies": {
-    "@custom-elements-manifest/analyzer": "patch:@custom-elements-manifest/analyzer@npm%3A0.10.6#~/.yarn/patches/@custom-elements-manifest-analyzer-npm-0.10.6-9b5ff0c50b.patch",
+    "@custom-elements-manifest/analyzer": "^0.10.10",
     "@typescript-eslint/eslint-plugin": "^6.9.0",
     "@typescript-eslint/parser": "^6.9.0",
     "@wdio/cli": "^7.19.7",
@@ -81,5 +81,5 @@
     "esbuild": "^0.25.0",
     "yargs": "^17.5.1"
   },
-  "gitHead": "5c40df56e6b1b834e277adee102d0e299a5c772c"
+  "gitHead": "265099a61a699bab43272f38673a637a9caf7ca5"
 }