TypeScript: Generate CommonJS module types with flow-api-translator 0.333

.eslintrc.js

@@ -60,14 +60,5 @@ module.exports = {
         'import/no-commonjs': 'off',
       },
     },
-    {
-      files: [
-        // flow-api-translator doesn't support translating `empty`
-        'packages/metro-file-map/types/flow-types.d.ts',
-      ],
-      rules: {
-        '@typescript-eslint/no-explicit-any': 'off',
-      },
-    },
   ],
 };

packages/metro-file-map/src/plugins/dependencies/worker.js

@@ -19,7 +19,7 @@ const defaultDependencyExtractor = require('./dependencyExtractor');
 import type {MetadataWorker, WorkerMessage, V8Serializable, DependencyExtractor} from '../../flow-types';
 */
 
-module.exports = class DependencyExtractorWorker /*:: implements MetadataWorker */ {
+class DependencyExtractorWorker /*:: implements MetadataWorker */ {
   // prettier-ignore
   /*:: readonly  */ #dependencyExtractor /*: ?DependencyExtractor['extract'] */;
 
@@ -56,4 +56,6 @@ module.exports = class DependencyExtractorWorker /*:: implements MetadataWorker
     // Return as array (PerFileData type)
     return Array.from(dependencies);
   }
-};
+}
+
+module.exports = DependencyExtractorWorker;

packages/metro-file-map/src/plugins/haste/worker.js

@@ -21,7 +21,7 @@ import type {MetadataWorker, WorkerMessage, V8Serializable} from '../../flow-typ
 
 const PACKAGE_JSON = path.sep + 'package.json';
 
-module.exports = class Worker /*:: implements MetadataWorker */ {
+class Worker /*:: implements MetadataWorker */ {
   /*:: readonly  */ #hasteImpl /*: ?Readonly<{getHasteName: string => ?string}>  */ =
     null;
 
@@ -63,4 +63,6 @@ module.exports = class Worker /*:: implements MetadataWorker */ {
     }
     return hasteName;
   }
-};
+}
+
+module.exports = Worker;

packages/metro-minify-terser/API.md

@@ -4,7 +4,9 @@
 
 ```ts
 
-const minifierFn: typeof minifier;
-export default minifierFn;
+const $$MODULE_EXPORTS$$: typeof minifier;
+
+type $$MODULE_EXPORTS$$ = typeof $$MODULE_EXPORTS$$;
+export default $$MODULE_EXPORTS$$;
 
 ```

packages/metro-runtime/API-modules-HMRClient.md

@@ -0,0 +1,20 @@
+## API Report File for "metro-runtime"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import EventEmitter = require('./vendor/eventemitter3');
+
+class HMRClient extends EventEmitter {
+  constructor(url: string);
+  close(): void;
+  disable(): void;
+  enable(): void;
+  hasPendingUpdates(): boolean;
+  isEnabled(): boolean;
+  send(message: string): void;
+}
+export default HMRClient;
+
+```

packages/metro-runtime/API-modules-asyncRequire.md

@@ -0,0 +1,22 @@
+## API Report File for "metro-runtime"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+const $$MODULE_EXPORTS$$: AsyncRequire;
+
+type $$MODULE_EXPORTS$$ = typeof $$MODULE_EXPORTS$$;
+export default $$MODULE_EXPORTS$$;
+
+export type AsyncRequire = {
+  <T>(moduleID: number, paths: DependencyMapPaths, moduleName?: string): Promise<T>;
+  unstable_importMaybeSync<T>(moduleID: number, paths: DependencyMapPaths): Promise<T> | T;
+  prefetch(moduleID: number, paths: DependencyMapPaths, moduleName?: string): void;
+};
+
+export type DependencyMapPaths = null | undefined | Readonly<{[moduleID: number | string]: ReadonlyJsonData}>;
+
+export type ReadonlyJsonData = null | boolean | number | string | ReadonlyArray<ReadonlyJsonData> | Readonly<{[$$Key$$: string]: ReadonlyJsonData}>;
+
+```

packages/metro-runtime/API-modules-null-module.md

@@ -0,0 +1,12 @@
+## API Report File for "metro-runtime"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+const $$MODULE_EXPORTS$$: null;
+
+type $$MODULE_EXPORTS$$ = typeof $$MODULE_EXPORTS$$;
+export default $$MODULE_EXPORTS$$;
+
+```

packages/metro-runtime/API-polyfills-require.md

@@ -0,0 +1,41 @@
+## API Report File for "metro-runtime"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+export type ArrayIndexable<T> = Readonly<{[indexer: number]: T}>;
+
+export type DefineFn = (factory: FactoryFn, moduleId: number, dependencyMap?: DependencyMap, verboseName?: string, inverseDependencies?: InverseDependencyMap) => void;
+
+export type DependencyMap = Readonly<
+  ArrayIndexable<ModuleID> & {
+    paths?: {[id in ModuleID]: string} | undefined;
+  }
+>;
+
+export type Exports = any;
+
+export type FactoryFn = (
+  global: object,
+  require: RequireFn,
+  metroImportDefault: RequireFn,
+  metroImportAll: RequireFn,
+  moduleObject: {exports: {}},
+  exports: {},
+  dependencyMap: null | undefined | DependencyMap,
+) => void;
+
+export type InverseDependencyMap = {[key in ModuleID]: Array<ModuleID>};
+
+export function metroImportAll(moduleId: ModuleID | VerboseModuleNameForDev | number): any | Exports | {[$$Key$$: string]: any};
+
+export function metroImportDefault(moduleId: ModuleID | VerboseModuleNameForDev): any | Exports;
+
+export type ModuleID = number;
+
+export type RequireFn = (id: ModuleID | VerboseModuleNameForDev) => Exports;
+
+export type VerboseModuleNameForDev = string;
+
+```

packages/metro-runtime/src/modules/asyncRequire.js

@@ -32,6 +32,24 @@ type DependencyMapPaths = ?Readonly<{
   [moduleID: number | string]: ReadonlyJsonData,
 }>;
 
+type AsyncRequire = {
+  <T>(
+    moduleID: number,
+    paths: DependencyMapPaths,
+    moduleName?: string,
+  ): Promise<T>,
+  unstable_importMaybeSync<T>(
+    moduleID: number,
+    paths: DependencyMapPaths,
+  ): Promise<T> | T,
+  prefetch(
+    moduleID: number,
+    paths: DependencyMapPaths,
+    moduleName?: string,
+  ): void,
+  ...
+};
+
 declare var __METRO_GLOBAL_PREFIX__: string;
 
 function maybeLoadBundle(
@@ -97,4 +115,5 @@ asyncRequire.prefetch = function (
   );
 };
 
-module.exports = asyncRequire;
+// The explicit type carries the statics through to generated type definitions.
+module.exports = asyncRequire as AsyncRequire;

scripts/eslint/typescript.js

@@ -27,4 +27,18 @@ module.exports = {
   ],
   plugins: ['@typescript-eslint'],
   parser: '@typescript-eslint/parser',
+  rules: {
+    // These files are generated from Flow sources, which Flow itself checks -
+    // an `any` here reflects one in the Flow source, or a construct the
+    // translator can't express.
+    '@typescript-eslint/no-explicit-any': 'off',
+    // Noise in generated definitions: a declaration a CommonJS module exports
+    // via `typeof` is reported as unused. The generator runs this rule itself,
+    // with `--fix`, to drop declarations that really are unused.
+    '@typescript-eslint/no-unused-vars': 'off',
+    // Flow's inexact `{...}` translates to `{}`, which this rule flags. The
+    // Flow sources that produce one are worth fixing rather than silencing, so
+    // this is off only until they are.
+    '@typescript-eslint/no-empty-object-type': 'off',
+  },
 };