fix: Generate schema for unspecified re-exported types (#1893)

* fix: Generate schema for unspecified re-exported types * Clarify comments
vega · Mar 26, 2024 · 5928a3d · 5928a3d
1 parent 031f3ea
commit 5928a3d
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 1 deletion.
diff --git a/src/SchemaGenerator.ts b/src/SchemaGenerator.ts
@@ -167,6 +167,25 @@ export class SchemaGenerator {
             case ts.SyntaxKind.ArrowFunction:
                 allTypes.set(`NamedParameters<typeof ${this.getFullName(node, typeChecker)}>`, node);
                 return;
+            case ts.SyntaxKind.ExportSpecifier: {
+                const exportSpecifierNode = node as ts.ExportSpecifier;
+                const symbol = typeChecker.getExportSpecifierLocalTargetSymbol(exportSpecifierNode);
+                if (symbol?.declarations?.length === 1) {
+                    const declaration = symbol.declarations[0];
+                    if (declaration.kind === ts.SyntaxKind.ImportSpecifier) {
+                        // Handling the `Foo` in `import { Foo } from "./lib"; export { Foo };`
+                        const importSpecifierNode = declaration as ts.ImportSpecifier;
+                        const type = typeChecker.getTypeAtLocation(importSpecifierNode);
+                        if (type.symbol?.declarations?.length === 1) {
+                            this.inspectNode(type.symbol.declarations[0], typeChecker, allTypes);
+                        }
+                    } else {
+                        // Handling the `Bar` in `export { Bar } from './lib';`
+                        this.inspectNode(declaration, typeChecker, allTypes);
+                    }
+                }
+                return;
+            }
             default:
                 ts.forEachChild(node, (subnode) => this.inspectNode(subnode, typeChecker, allTypes));
                 return;

diff --git a/test/utils.ts b/test/utils.ts
@@ -47,12 +47,13 @@ export function assertValidSchema(
          * @default {strict:false}
          */
         ajvOptions?: AjvOptions;
+        mainTsOnly?: boolean;
     }
 ) {
     return (): void => {
         const config: Config = {
             ...DEFAULT_CONFIG,
-            path: `${basePath}/${relativePath}/*.ts`,
+            path: `${basePath}/${relativePath}/${options?.mainTsOnly ? "main" : "*"}.ts`,
             skipTypeCheck: !!process.env.FAST_TEST,
             type,
             ...config_,

diff --git a/test/valid-data-other.test.ts b/test/valid-data-other.test.ts
@@ -102,4 +102,5 @@ describe("valid-data-other", () => {
             ajvOptions: { $data: true },
         })
     );
+    it("re-export-with-asterisk", assertValidSchema("re-export-with-asterisk", "*", undefined, { mainTsOnly: true }));
 });
diff --git a/test/valid-data/re-export-with-asterisk/lib.ts b/test/valid-data/re-export-with-asterisk/lib.ts
@@ -0,0 +1,8 @@
+export enum MyEnum {
+    Foo = "foo",
+    Bar = "bar",
+}
+
+export interface MyObject {
+    id: string;
+}
diff --git a/test/valid-data/re-export-with-asterisk/main.ts b/test/valid-data/re-export-with-asterisk/main.ts
@@ -0,0 +1,3 @@
+export { MyObject } from "./lib";
+import { MyEnum } from "./lib";
+export { MyEnum };
diff --git a/test/valid-data/re-export-with-asterisk/schema.json b/test/valid-data/re-export-with-asterisk/schema.json
@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "MyEnum": {
+      "enum": [
+        "foo",
+        "bar"
+      ],
+      "type": "string"
+    },
+    "MyObject": {
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id"
+      ],
+      "type": "object"
+    }
+  }
+}