Fix interface extends inference

Author: ShukantPal

example/example.api.json

@@ -407,6 +407,30 @@
 						}
 					]
 				},
+				{
+					"name": "",
+					"type": "TypedefDoc",
+					"brief": "",
+					"description": "",
+					"members": [
+						{
+							"name": "destroy",
+							"type": "PropertyDoc",
+							"access": "public",
+							"scope": "static",
+							"brief": "",
+							"description": "<p>Called when destroying Application, scoped to Application instance</p>"
+						},
+						{
+							"name": "init",
+							"type": "PropertyDoc",
+							"access": "public",
+							"scope": "static",
+							"brief": "",
+							"description": "<p>Called when Application is constructed, scoped to Application instance.\nPasses in <code>options</code> as the only argument, which are Application constructor options.</p>"
+						}
+					]
+				},
 				{
 					"name": "SVG_SIZE",
 					"type": "PropertyDoc",

example/src/StreamBuilder.js

@@ -767,3 +767,15 @@ export class ObjectRenderer {
     // render the object
   }
 }
+
+/**
+ * @memberof PIXI
+ * @typedef {object}
+ * @property {function} init - Called when Application is constructed, scoped to Application instance.
+ *  Passes in `options` as the only argument, which are Application constructor options.
+ * @property {function} destroy - Called when destroying Application, scoped to Application instance
+ */
+export interface IApplicationPlugin {
+    init: (...params: any[]) => any;
+    destroy: (...params: any[]) => any;
+}

packages/webdoc-parser/src/symbols-babel/extract-metadata.js

@@ -4,6 +4,8 @@
 
 import {
   type BabelNodeFlow,
+  type BabelNodeMemberExpression,
+  type BabelNodeQualifiedName,
   type BabelNodeTSTypeAnnotation,
   type BabelNodeTypeAnnotation,
   type ClassDeclaration,
@@ -15,6 +17,7 @@ import {
   type ObjectMethod,
   type TSInterfaceDeclaration,
   type TSMethodSignature,
+  type TSQualifiedName,
   type TSType,
   type TSTypeAnnotation,
   isAnyTypeAnnotation,
@@ -31,6 +34,7 @@ import {
   isGenericTypeAnnotation,
   isIdentifier,
   isIntersectionTypeAnnotation,
+  isMemberExpression,
   isMixedTypeAnnotation,
   isNullLiteralTypeAnnotation,
   isNullableTypeAnnotation,
@@ -47,6 +51,7 @@ import {
   isStringTypeAnnotation,
   isTSAnyKeyword,
   isTSArrayType,
+  isTSAsExpression,
   isTSBigIntKeyword,
   isTSBooleanKeyword,
   isTSConstructSignatureDeclaration,
@@ -81,6 +86,7 @@ import {
   isTSUnionType,
   isTSUnknownKeyword,
   isTSVoidKeyword,
+  isThisExpression,
   isThisTypeAnnotation,
   isTupleTypeAnnotation,
   isTypeAnnotation,
@@ -116,6 +122,9 @@ export function extractExtends(
     if (isIdentifier(node.superClass)) {
       return [node.superClass.name];
     }
+    if (isMemberExpression(node.superClass)) {
+      return [reduceMemberExpression(node.superClass)];
+    }
 
     return null;
   }
@@ -127,6 +136,15 @@ export function extractExtends(
     if (isIdentifier(exs.id)) {
       return exs.id.name;
     }
+    if (isQualifiedTypeIdentifier(exs.id)) {
+      return reduceQualifiedName(exs.id);
+    }
+    if (isIdentifier(exs.expression)) {
+      return exs.expression.name;
+    }
+    if (isTSQualifiedName(exs.expression)) {
+      return reduceTSQualifiedName(exs.expression);
+    }
 
     // TODO: QualifiedTypeIdentifier
     return "";
@@ -144,10 +162,18 @@ export function extractImplements(
     if (isTSExpressionWithTypeArguments(impls)) {
       if (isIdentifier(impls.expression)) {
         return impls.expression.name;
-      } else {
-        // TODO: TSQualifiedName
-        return "";
       }
+      if (isQualifiedTypeIdentifier(impls.id)) {
+        return reduceQualifiedName(impls.id);
+      }
+      if (isIdentifier(impls.expression)) {
+        return impls.expression.name;
+      }
+      if (isTSQualifiedName(impls.expression)) {
+        return reduceTSQualifiedName(impls.expression);
+      }
+
+      return "";
     }
   }) : null;
 }
@@ -255,6 +281,60 @@ export function extractType(
   }
 }
 
+// Helper to resolve assignment to object chain, e.g. [Class.prototype].property
+function reduceMemberExpression(expression: BabelNodeMemberExpression): string {
+  let longname = "";
+
+  if (isTSAsExpression(expression)) {
+    expression = expression.expression;
+  }
+  if (isThisExpression(expression)) {
+    return "this";
+  }
+
+  while (expression.object) {
+    longname = expression.property.name + (longname ? "." + longname : "");
+    expression = expression.object;
+  }
+
+  longname = (isThisExpression(expression) ? "this" : expression.name) +
+    (longname ? "." : "") + longname;
+
+  return longname;
+}
+
+// Reduce the qualified name into a string
+function reduceQualifiedName(type: BabelNodeQualifiedName): string {
+  let name = "";
+
+  while (type && !isIdentifier(type)) {
+    name = type.id.name + (name ? "." : "") + name;
+    type = type.qualification;
+  }
+
+  if (type) {
+    name = type.name + "." + name;
+  }
+
+  return name;
+}
+
+// Reduce the qualified name node into a string
+function reduceTSQualifiedName(type: TSQualifiedName): string {
+  let name = "";
+
+  while (type && !isIdentifier(type)) {
+    name = type.right.name + (name ? "." : "") + name;
+    type = type.left;
+  }
+
+  if (type) {
+    name = type.name + "." + name;
+  }
+
+  return name;
+}
+
 // Resolve a flow type-annotation into a parsed DataType
 function resolveFlowDataType(type: BabelNodeTypeAnnotation | BabelNodeFlow | any): DataType {
   if (isTypeAnnotation(type)) {
@@ -290,18 +370,7 @@ function resolveFlowDataType(type: BabelNodeTypeAnnotation | BabelNodeFlow | any
     return dataType;
   }
   if (isQualifiedTypeIdentifier(type)) {
-    let name = "";
-
-    while (type && !isIdentifier(type)) {
-      name = type.id.name + (name ? "." : "") + name;
-      type = type.qualification;
-    }
-
-    if (type) {
-      name = type.id + "." + name;
-    }
-
-    return createSimpleDocumentedType(name);
+    return createSimpleDocumentedType(reduceQualifiedName(type));
   }
   if (isObjectTypeIndexer(type)) {
     const id = type.id ? type.id.name : null;
@@ -440,18 +509,7 @@ function resolveTSDataType(type: TSTypeAnnotation | TSType | any): DataType {
   if (isIdentifier(type)) {
     return createSimpleDocumentedType(type.name);
   } else if (isTSQualifiedName(type)) { // TSQualifiedName
-    let name = "";
-
-    while (type && !isIdentifier(type)) {
-      name = type.right.name + (name ? "." : "") + name;
-      type = type.left;
-    }
-
-    if (type) {
-      name = type.name + "." + name;
-    }
-
-    return createSimpleDocumentedType(name);
+    return createSimpleDocumentedType(reduceTSQualifiedName(type));
   }
 
   if (isTSType(type)) {

packages/webdoc-parser/test/lang-flow.js

@@ -0,0 +1,26 @@
+const {buildSymbolTree} = require("../lib/parse");
+
+const expect = require("chai").expect;
+
+describe("@webdoc/parser.LanguageIntegration{@lang flow}", function() {
+  it("should parse extends, implements", function() {
+    const symtree = buildSymbolTree(`
+      interface IArrayBuffer extends ArrayBuffer {}
+      class ArrayBufferImpl implements ArrayBuffer {}
+      interface SpecializedArrayBuffer extends Special.ArrayBuffer {}
+      class SpecializedArrayBufferImpl extends Special.ArrayBuffer {}
+    `, "*.js");
+
+    const [
+      iarrayBuffer,
+      arrayBufferImpl,
+      specializedArrayBuffer,
+      specializedArrayBufferImpl,
+    ] = symtree.members;
+
+    expect(iarrayBuffer.meta.extends[0]).to.equal("ArrayBuffer");
+    expect(arrayBufferImpl.meta.implements[0]).to.equal("ArrayBuffer");
+    expect(specializedArrayBuffer.meta.extends[0]).to.equal("Special.ArrayBuffer");
+    expect(specializedArrayBufferImpl.meta.extends[0]).to.equal("Special.ArrayBuffer");
+  });
+});

packages/webdoc-parser/test/lang-ts.js

@@ -115,12 +115,35 @@ describe("@webdoc/parser.LanguageIntegration{@lang ts}", function() {
         num = 1;
         str = "string";
       }
-    `);
+    `, "*.ts");
 
     const [bool, num, str] = symtree.members[0].members;
 
     expect(bool.meta.dataType[0]).to.equal("boolean");
     expect(num.meta.dataType[0]).to.equal("number");
     expect(str.meta.dataType[0]).to.equal("string");
   });
+
+  it("should parse extends, implements", function() {
+    const symtree = buildSymbolTree(`
+      interface IArrayBuffer extends ArrayBuffer {}
+      class ArrayBufferImpl implements ArrayBuffer {}
+      interface SpecializedArrayBuffer extends Special.IArrayBuffer {}
+      class SpecializedArrayBufferImpl extends Special.ArrayBuffer
+        implements Special.IArrayBuffer {}
+    `, "*.ts");
+
+    const [
+      iarrayBuffer,
+      arrayBufferImpl,
+      specializedArrayBuffer,
+      specializedArrayBufferImpl,
+    ] = symtree.members;
+
+    expect(iarrayBuffer.meta.extends[0]).to.equal("ArrayBuffer");
+    expect(arrayBufferImpl.meta.implements[0]).to.equal("ArrayBuffer");
+    expect(specializedArrayBuffer.meta.extends[0]).to.equal("Special.IArrayBuffer");
+    expect(specializedArrayBufferImpl.meta.implements[0]).to.equal("Special.IArrayBuffer");
+    expect(specializedArrayBufferImpl.meta.extends[0]).to.equal("Special.ArrayBuffer");
+  });
 });