fix(ts): migrate saveDocs.js

.nvmrc

@@ -1 +1 @@
-14.16.1
+14.16.1

src/@types/pkg.ts

@@ -76,3 +76,11 @@ export interface RawPkg {
     alternativeNames: string[];
   };
 }
+
+export type FinalPkg = RawPkg & {
+  _searchInternal: {
+    downloadsMagnitude?: number;
+    jsDelivrPopularity?: number;
+    popularName?: string;
+  };
+};

src/bootstrap.js

@@ -3,7 +3,7 @@ import ms from 'ms';
 import * as algolia from './algolia';
 import { config } from './config';
 import * as npm from './npm';
-import saveDocs from './saveDocs.js';
+import saveDocs from './saveDocs';
 import { datadog } from './utils/datadog';
 import { log } from './utils/log';
 

src/npm/index.ts

@@ -153,10 +153,9 @@ function getDependents(
 ): Promise<Array<{ dependents: number; humanDependents: string }>> {
   // we return 0, waiting for https://github.com/npm/registry/issues/361
   return Promise.all(
-    pkgs.map(() => ({
-      dependents: 0,
-      humanDependents: '0',
-    }))
+    pkgs.map(() => {
+      return { dependents: 0, humanDependents: '0' };
+    })
   );
 }
 
@@ -214,19 +213,16 @@ async function getDownload(
  * Get downloads for all packages passer in arguments.
  */
 async function getDownloads(pkgs: Array<Pick<RawPkg, 'name'>>): Promise<
-  Array<
-    | {
-        downloadsLast30Days: number;
-        humanDownloadsLast30Days: string;
-        downloadsRatio: number;
-        popular: boolean;
-        _searchInternal: {
-          popularName?: string;
-          downloadsMagnitude: number;
-        };
-      }
-    | Record<string, unknown>
-  >
+  Array<{
+    downloadsLast30Days: number;
+    humanDownloadsLast30Days: string;
+    downloadsRatio: number;
+    popular: boolean;
+    _searchInternal: {
+      popularName?: string;
+      downloadsMagnitude: number;
+    };
+  } | null>
 > {
   const start = Date.now();
 
@@ -265,7 +261,7 @@ async function getDownloads(pkgs: Array<Pick<RawPkg, 'name'>>): Promise<
 
   const all = pkgs.map(({ name }) => {
     if (downloadsPerPkgName[name] === undefined) {
-      return {};
+      return null;
     }
 
     const downloadsLast30Days = downloadsPerPkgName[name]

src/saveDocs.js → src/saveDocs.ts

@@ -1,33 +1,51 @@
+import type { SearchIndex } from 'algoliasearch';
+import type nano from 'nano';
+
+import type { FinalPkg, RawPkg } from './@types/pkg';
 import { getChangelogs } from './changelog';
 import formatPkg from './formatPkg';
 import * as jsDelivr from './jsDelivr';
 import * as npm from './npm';
+import type { GetPackage } from './npm/types';
 import { getTSSupport } from './typescriptSupport';
 import { datadog } from './utils/datadog';
 import { log } from './utils/log';
 
-export default async function saveDocs({ docs, index }) {
+export default async function saveDocs({
+  docs,
+  index,
+}: {
+  docs: Array<nano.DocumentResponseRow<GetPackage>>;
+  index: SearchIndex;
+}): Promise<number> {
   const start = Date.now();
 
   const rawPkgs = docs
     .filter(
       // must be a document & have a name
-      (result) =>
-        !result.deleted && result && result.doc && result.doc.name !== undefined
+      (result) => {
+        return (
+          // @ts-expect-error Docs is either a doc or changes, the types or the values need to be checked
+          !result.deleted &&
+          result &&
+          result.doc &&
+          result.doc.name !== undefined
+        );
+      }
     )
     .map((result) => {
       const start1 = Date.now();
 
-      const formatted = formatPkg(result.doc);
+      const formatted = formatPkg(result.doc!);
 
       datadog.timing('formatPkg', Date.now() - start1);
       return formatted;
     })
-    .filter((pkg) => pkg !== undefined);
+    .filter<RawPkg>((pkg): pkg is RawPkg => pkg !== undefined);
 
   if (rawPkgs.length === 0) {
     log.info('🔍 No pkgs found in response.');
-    return Promise.resolve();
+    return Promise.resolve(0);
   }
 
   let start2 = Date.now();
@@ -42,7 +60,7 @@ export default async function saveDocs({ docs, index }) {
   return pkgs.length;
 }
 
-async function addMetaData(pkgs) {
+async function addMetaData(pkgs: RawPkg[]): Promise<FinalPkg[]> {
   const [downloads, dependents, changelogs, hits, ts] = await Promise.all([
     npm.getDownloads(pkgs),
     npm.getDependents(pkgs),
@@ -52,21 +70,22 @@ async function addMetaData(pkgs) {
   ]);
 
   const start = Date.now();
-  const all = pkgs.map((pkg, index) => ({
-    ...pkg,
-    ...downloads[index],
-    ...dependents[index],
-    ...changelogs[index],
-    ...hits[index],
-    ...ts[index],
-    _searchInternal: {
-      ...pkg._searchInternal,
-      ...downloads[index]._searchInternal,
-      ...dependents[index]._searchInternal,
-      ...changelogs[index]._searchInternal,
-      ...hits[index]._searchInternal,
-    },
-  }));
+  const all: FinalPkg[] = pkgs.map((pkg, index) => {
+    return {
+      ...pkg,
+      ...downloads[index],
+      ...dependents[index],
+      ...changelogs[index],
+      ...hits[index],
+      ...ts[index],
+      _searchInternal: {
+        ...pkg._searchInternal,
+        ...(downloads[index] ? downloads[index]!._searchInternal : {}),
+        ...hits[index]._searchInternal,
+      },
+    };
+  });
+
   datadog.timing('saveDocs.addMetaData', Date.now() - start);
   return all;
 }

src/watch.js

@@ -3,7 +3,7 @@ import ms from 'ms';
 
 import { config } from './config';
 import * as npm from './npm';
-import saveDocs from './saveDocs.js';
+import saveDocs from './saveDocs';
 import { datadog } from './utils/datadog';
 import { log } from './utils/log';
 import * as sentry from './utils/sentry';