fix(TS): support scoped packages (#364)

* fix(TS): support scoped packages

Also changed the schema to make it easier to filter based on type

* docs: add to the readme

README.md

@@ -118,7 +118,10 @@ For every single NPM package, we create a record in the Algolia index. The resul
   ],
   lastCrawl: '2017-10-24T08:29:24.672Z',
   dependents: 3321,
-  types: { ts: '@types/babel-core' }, // @types/xxx | included | false
+  types: {
+    ts: 'definitely-typed', // definitely-typed | included | false
+    definitelyTyped: '@types/babel__core',
+  },
   humanDependents: '3.3k',
   changelogFilename: null, // if babel-core had a changelog, it would be the raw GitHub url here
   objectID: 'babel-core',

src/__tests__/typescript.test.js

@@ -21,7 +21,26 @@ describe('getTypeScriptSupport()', () => {
         name: 'my-lib',
         types: { ts: false },
       });
-      expect(atTypesSupport).toEqual({ types: { ts: '@types/my-lib' } });
+      expect(atTypesSupport).toEqual({
+        types: {
+          ts: 'definitely-typed',
+          definitelyTyped: '@types/my-lib',
+        },
+      });
+    });
+
+    it('Checks for @types/[scope__name]', async () => {
+      validatePackageExists.mockResolvedValue(true);
+      const atTypesSupport = await getTypeScriptSupport({
+        name: '@my-scope/my-lib',
+        types: { ts: false },
+      });
+      expect(atTypesSupport).toEqual({
+        types: {
+          ts: 'definitely-typed',
+          definitelyTyped: '@types/my-scope__my-lib',
+        },
+      });
     });
 
     it('Checks for a d.ts resolved version of main ', async () => {

src/typescriptSupport.js

@@ -24,10 +24,15 @@ export async function getTypeScriptSupport(pkg) {
   }
 
   // The 2nd most likely is definitely typed
-  const defTypeName = `@types/${pkg.name}`;
+  const defTypeName = `@types/${pkg.name.replace('@', '').replace('/', '__')}`;
   const defTyped = await validatePackageExists(defTypeName);
   if (defTyped) {
-    return { types: { ts: defTypeName } };
+    return {
+      types: {
+        ts: 'definitely-typed',
+        definitelyTyped: defTypeName,
+      },
+    };
   }
 
   if (pkg.types.ts === false) {