Use 'types' property to detect index.d.ts file

Closes LinkedSoftwareDependencies/Components.js#19

Author: rubensworks

lib/generate/Generator.ts

@@ -34,7 +34,7 @@ export class Generator {
     const classIndexer = new ClassIndexer({ classLoader, classFinder });
 
     // Find all relevant classes
-    const packageExports = await classFinder.getPackageExports(this.pathDestination.packageRootDirectory);
+    const packageExports = await classFinder.getPackageExports(packageMetadata.typesPath);
     const classIndex = await classIndexer.createIndex(packageExports);
 
     // Load constructor data

lib/parse/ClassFinder.ts

@@ -1,4 +1,3 @@
-import * as Path from 'path';
 import { ClassIndex, ClassReference } from './ClassIndex';
 import { ClassLoader } from './ClassLoader';
 
@@ -14,15 +13,14 @@ export class ClassFinder {
   }
 
   /**
-   * From a given package directory, find all named exports.
-   * It is assumed that the given package contains an index.d.ts file.
-   * @param packageRootDirectory The path of a package.
+   * From a given types index, find all named exports.
+   * @param typesPath The path to the index typings file.
    */
-  public async getPackageExports(packageRootDirectory: string): Promise<ClassIndex<ClassReference>> {
+  public async getPackageExports(typesPath: string): Promise<ClassIndex<ClassReference>> {
     let exports: ClassIndex<ClassReference> = {};
 
     // Start from the package index, and collect all named exports.
-    const paths = [ Path.join(packageRootDirectory, 'index') ];
+    const paths = [ typesPath ];
     for (const path of paths) {
       const { named, unnamed } = await this.getFileExports(path);
       exports = { ...exports, ...named };

lib/parse/PackageMetadataLoader.ts

@@ -45,6 +45,15 @@ export class PackageMetadataLoader {
       throw new Error(`Invalid package: Missing 'lsd:importPaths' in ${packageJsonPath}`);
     }
     const importPaths = packageJson['lsd:importPaths'];
+    if (!('types' in packageJson)) {
+      throw new Error(`Invalid package: Missing 'types' in ${packageJsonPath}`);
+    }
+    let typesPath = Path.join(packageRootDirectory, packageJson.types);
+    if (!typesPath.endsWith('.d.ts')) {
+      throw new Error(`Invalid package: 'types' entry does not have '.d.ts' suffix in ${packageJsonPath}`);
+    } else {
+      typesPath = typesPath.slice(0, -5);
+    }
 
     // Construct metadata hash
     return {
@@ -54,6 +63,7 @@ export class PackageMetadataLoader {
       componentsPath,
       contexts,
       importPaths,
+      typesPath,
     };
   }
 }
@@ -69,4 +79,5 @@ export interface PackageMetadata {
   componentsPath: string;
   contexts: {[iri: string]: string};
   importPaths: {[iri: string]: string};
+  typesPath: string;
 }

test/parse/ClassFinder.test.ts

@@ -221,7 +221,7 @@ export {A};
         [Path.normalize('package-simple-named/index.d.ts')]: `export {A as B} from './lib/A';`,
         [Path.normalize('package-simple-named/lib/A.d.ts')]: 'export class A {}',
       };
-      expect(await parser.getPackageExports('package-simple-named'))
+      expect(await parser.getPackageExports('package-simple-named/index'))
         .toEqual({
           B: {
             fileName: Path.normalize('package-simple-named/lib/A'),
@@ -235,7 +235,7 @@ export {A};
         [Path.normalize('package-simple-unnamed/index.d.ts')]: `export * from './lib/A';`,
         [Path.normalize('package-simple-unnamed/lib/A.d.ts')]: 'export class A {}',
       };
-      expect(await parser.getPackageExports('package-simple-unnamed'))
+      expect(await parser.getPackageExports('package-simple-unnamed/index'))
         .toEqual({
           A: {
             fileName: Path.normalize('package-simple-unnamed/lib/A'),
@@ -253,7 +253,7 @@ export * from './lib/C';
         [Path.normalize('package-multiple/lib/A.d.ts')]: 'export class A {}',
         [Path.normalize('package-multiple/lib/C.d.ts')]: 'export class C {}',
       };
-      expect(await parser.getPackageExports('package-multiple'))
+      expect(await parser.getPackageExports('package-multiple/index'))
         .toEqual({
           B: {
             fileName: Path.normalize('package-multiple/lib/A'),
@@ -276,7 +276,7 @@ export * from './sub2/C'
         [Path.normalize('package-nested/lib/sub1/B.d.ts')]: 'export class B {}',
         [Path.normalize('package-nested/lib/sub2/C.d.ts')]: 'export class C {}',
       };
-      expect(await parser.getPackageExports('package-nested'))
+      expect(await parser.getPackageExports('package-nested/index'))
         .toEqual({
           B: {
             fileName: Path.normalize('package-nested/lib/sub1/B'),

test/parse/PackageMetadataLoader.test.ts

@@ -30,7 +30,8 @@ describe('PackageMetadataLoader', () => {
   "lsd:importPaths": {
     "https://example.org/bundles/npm/@solid/community-server/^1.0.0/components/": "components/",
     "https://example.org/bundles/npm/@solid/community-server/^1.0.0/config/": "config/"
-  }
+  },
+  "types": "./index.d.ts"
 }`,
       };
       expect(await loader.load('/')).toEqual({
@@ -46,6 +47,7 @@ describe('PackageMetadataLoader', () => {
         moduleIri: 'https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server',
         name: '@solid/community-server',
         version: '1.2.3',
+        typesPath: Path.normalize('/index'),
       });
     });
 
@@ -114,5 +116,44 @@ describe('PackageMetadataLoader', () => {
       await expect(loader.load('/')).rejects
         .toThrow(new Error(`Invalid package: Missing 'lsd:importPaths' in ${Path.normalize('/package.json')}`));
     });
+
+    it('should error when types is missing', async() => {
+      resolutionContext.contentsOverrides = {
+        [Path.normalize('/package.json')]: `{
+  "name": "@solid/community-server",
+  "lsd:module": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server",
+  "lsd:components": "components/components.jsonld",
+  "lsd:contexts": {
+    "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/components/context.jsonld": "components/context.jsonld"
+  },
+  "lsd:importPaths": {
+    "https://example.org/bundles/npm/@solid/community-server/^1.0.0/components/": "components/",
+    "https://example.org/bundles/npm/@solid/community-server/^1.0.0/config/": "config/"
+  }
+}`,
+      };
+      await expect(loader.load('/')).rejects
+        .toThrow(new Error(`Invalid package: Missing 'types' in ${Path.normalize('/package.json')}`));
+    });
+
+    it('should error when types does not end with .d.ts', async() => {
+      resolutionContext.contentsOverrides = {
+        [Path.normalize('/package.json')]: `{
+  "name": "@solid/community-server",
+  "lsd:module": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server",
+  "lsd:components": "components/components.jsonld",
+  "lsd:contexts": {
+    "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/components/context.jsonld": "components/context.jsonld"
+  },
+  "lsd:importPaths": {
+    "https://example.org/bundles/npm/@solid/community-server/^1.0.0/components/": "components/",
+    "https://example.org/bundles/npm/@solid/community-server/^1.0.0/config/": "config/"
+  },
+  "types": "index.ts"
+}`,
+      };
+      await expect(loader.load('/')).rejects
+        .toThrow(new Error(`Invalid package: 'types' entry does not have '.d.ts' suffix in ${Path.normalize('/package.json')}`));
+    });
   });
 });