fix(test-utils): Support re-export declarations

Author: just-boris

…per-classes/errors-no-wrapper-classes.ts …utils/errors-no-wrapper-classes/index.tsfixtures/test-utils/errors-no-wrapper-classes/errors-no-wrapper-classes.ts renamed to fixtures/test-utils/errors-no-wrapper-classes/index.ts fixtures/test-utils/errors-no-wrapper-classes/errors-no-wrapper-classes.ts renamed to fixtures/test-utils/errors-no-wrapper-classes/index.ts

@@ -1,4 +1,3 @@
 {
-  "extends": "../tsconfig.json",
-  "include": ["errors-no-wrapper-classes.ts"]
+  "extends": "../tsconfig.json"
 }

fixtures/test-utils/errors-no-wrapper-classes/tsconfig.json

@@ -0,0 +1,10 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { ElementWrapper } from './core';
+
+export class AlertWrapper extends ElementWrapper {
+  findContent() {
+    return new ElementWrapper();
+  }
+}

fixtures/test-utils/exports/alert.ts

@@ -0,0 +1,10 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { ElementWrapper } from './core';
+
+export class ButtonWrapper extends ElementWrapper {
+  findText() {
+    return new ElementWrapper();
+  }
+}

fixtures/test-utils/exports/button.ts

@@ -0,0 +1,3 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export class ElementWrapper {}

fixtures/test-utils/exports/core.ts

@@ -0,0 +1,4 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export { AlertWrapper } from './alert';
+export { ButtonWrapper } from './button';

fixtures/test-utils/exports/index.ts

@@ -0,0 +1,3 @@
+{
+  "extends": "../tsconfig.json"
+}

fixtures/test-utils/exports/tsconfig.json

@@ -107,3 +107,11 @@ export function extractDeclaration(symbol: ts.Symbol) {
   }
   return declarations[0];
 }
+
+export function printFlags(flags: number, mapping: Record<number, string>) {
+  /* v8 ignore next */
+  return Object.entries(mapping)
+    .filter(([key, value]) => Number(key) & flags)
+    .map(([key, value]) => value)
+    .join(' | ');
+}

src/components/type-utils.ts

@@ -43,11 +43,11 @@ export default function extractDocumentation(
     if (extraExports.includes(className)) {
       continue;
     }
-    if (!(symbol.flags & ts.SymbolFlags.Class)) {
+    const classType = checker.getDeclaredTypeOfSymbol(symbol);
+    if (!classType.isClass()) {
       throw new Error(`Exported symbol is not a class, got ${checker.symbolToString(symbol)}`);
     }
 
-    const classType = checker.getTypeAtLocation(extractDeclaration(symbol));
     const classDefinition: TestUtilsDoc = { name: className, methods: [] };
     for (const property of classType.getProperties()) {
       const declaration = property.valueDeclaration;

src/test-utils-new/extractor.ts

@@ -83,6 +83,15 @@ describe('Generate documentation', () => {
     expect(childClassMethod?.inheritedFrom).toBeUndefined();
   });
 
+  test('deal with re-exports', () => {
+    const results = buildTestUtilsProject('exports');
+    expect(results.map(classDoc => classDoc.name)).toEqual(['AlertWrapper', 'ButtonWrapper']);
+    const alertWrapper = results.find(classDoc => classDoc.name === 'AlertWrapper')!;
+    expect(alertWrapper.methods.map(method => method.name)).toEqual(['findContent']);
+    const buttonWrapper = results.find(classDoc => classDoc.name === 'ButtonWrapper')!;
+    expect(buttonWrapper.methods.map(method => method.name)).toEqual(['findText']);
+  });
+
   test('default value rendering', () => {
     const results = buildTestUtilsProject('default-values');
     expect(results.length).toBe(1);