Sync .d.ts files for remaining packages from DefinitelyTyped

Summary:
Adds definitely typed definitions for the following packages:
- `metro`
- `metro-babel-transfomer`
- `metro-config`
- `metro-core`
- `metro-file-map`
- `metro-resolver`
- `metro-source-map`
- `metro-transform-worker`

Thanks afoxman and tido64 for originally contributing these types in DefinitelyTyped! 🙌🏻

Changelog: **[Types]** Add bundled TypeScript definitions (partial) for all packages previously on DefinitelyTyped

Reviewed By: motiz88

Differential Revision: D44509764

fbshipit-source-id: 6c0c7f4054a47c3cccdf2630b5f694211b150cd3

packages/metro-babel-transformer/types/index.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * @oncall react_native
+ */
+
+import type {FBSourceFunctionMap} from 'metro-source-map';
+
+export interface CustomTransformOptions {
+  [key: string]: unknown;
+}
+
+export type TransformProfile = 'default' | 'hermes-stable' | 'hermes-canary';
+
+export interface BabelTransformerOptions {
+  readonly customTransformOptions?: CustomTransformOptions;
+  readonly dev: boolean;
+  readonly enableBabelRCLookup?: boolean;
+  readonly enableBabelRuntime: boolean | string;
+  readonly extendsBabelConfigPath?: string;
+  readonly experimentalImportSupport?: boolean;
+  readonly hermesParser?: boolean;
+  readonly hot: boolean;
+  readonly inlineRequires: boolean;
+  readonly nonInlinedRequires?: ReadonlyArray<string>;
+  readonly minify: boolean;
+  readonly unstable_disableES6Transforms?: boolean;
+  readonly platform: string | null;
+  readonly projectRoot: string;
+  readonly publicPath: string;
+  readonly unstable_transformProfile?: TransformProfile;
+  readonly globalPrefix: string;
+}
+
+export interface BabelTransformerArgs {
+  readonly filename: string;
+  readonly options: BabelTransformerOptions;
+  readonly plugins?: unknown;
+  readonly src: string;
+}
+
+export interface BabelTransformer {
+  transform: (args: BabelTransformerArgs) => {
+    ast: unknown;
+    functionMap: FBSourceFunctionMap | null;
+  };
+  getCacheKey?: () => string;
+}
+
+export const transform: BabelTransformer['transform'];

packages/metro-config/types/configTypes.d.ts

@@ -0,0 +1,256 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * @oncall react_native
+ */
+
+import type {IncomingMessage, ServerResponse} from 'http';
+import type {CacheStore, MetroCache} from 'metro-cache';
+import type {CustomResolver} from 'metro-resolver';
+import type {JsTransformerConfig} from 'metro-transform-worker';
+import type {
+  DeltaResult,
+  Module,
+  ReadOnlyGraph,
+  SerializerOptions,
+  TransformResult,
+} from 'metro/DeltaBundler/types';
+import type {Reporter} from 'metro/lib/reporting';
+import type Server from 'metro/Server';
+
+export interface ExtraTransformOptions {
+  readonly preloadedModules: {[path: string]: true} | false;
+  readonly ramGroups: string[];
+  readonly transform: Readonly<{
+    experimentalImportSupport: boolean;
+    inlineRequires: {blockList: {[path: string]: true}} | boolean;
+    nonInlinedRequires?: ReadonlyArray<string>;
+    unstable_disableES6Transforms?: boolean;
+  }>;
+}
+
+export interface GetTransformOptionsOpts {
+  dev: boolean;
+  hot: boolean;
+  platform?: string;
+}
+
+export type GetTransformOptions = (
+  entryPoints: ReadonlyArray<string>,
+  options: GetTransformOptionsOpts,
+  getDependenciesOf: (filePath: string) => Promise<string[]>,
+) => Promise<Partial<ExtraTransformOptions>>;
+
+export type Middleware = (
+  incomingMessage: IncomingMessage,
+  serverResponse: ServerResponse,
+  error: (e?: Error) => unknown,
+) => unknown;
+
+export type PerfAnnotations = Partial<{
+  string: {[key: string]: string};
+  int: {[key: string]: number};
+  double: {[key: string]: number};
+  bool: {[key: string]: boolean};
+  string_array: {[key: string]: string[]};
+  int_array: {[key: string]: number[]};
+  double_array: {[key: string]: number[]};
+  bool_array: {[key: string]: boolean[]};
+}>;
+
+export type PerfLoggerPointOptions = Readonly<{
+  /**
+   * The time this event point occurred, if it differs from the time the point was logged.
+   */
+  timestamp?: number;
+}>;
+
+export interface PerfLogger {
+  point(name: string, opts?: PerfLoggerPointOptions): void;
+  annotate(annotations: PerfAnnotations): void;
+  subSpan(label: string): PerfLogger;
+}
+
+export interface RootPerfLogger extends PerfLogger {
+  start(opts?: PerfLoggerPointOptions): void;
+  end(
+    status: 'SUCCESS' | 'FAIL' | 'CANCEL',
+    opts?: PerfLoggerPointOptions,
+  ): void;
+}
+
+export type PerfLoggerFactoryOptions = Readonly<{
+  key?: number;
+}>;
+
+export type PerfLoggerFactory = (
+  type: 'START_UP' | 'BUNDLING_REQUEST' | 'HMR',
+  opts?: PerfLoggerFactoryOptions,
+) => RootPerfLogger;
+
+export interface ResolverConfigT {
+  assetExts: ReadonlyArray<string>;
+  assetResolutions: ReadonlyArray<string>;
+  blacklistRE?: RegExp | RegExp[];
+  blockList: RegExp | RegExp[];
+  dependencyExtractor?: string;
+  disableHierarchicalLookup: boolean;
+  extraNodeModules: {[name: string]: string};
+  emptyModulePath: string;
+  hasteImplModulePath?: string;
+  nodeModulesPaths: ReadonlyArray<string>;
+  platforms: ReadonlyArray<string>;
+  resolveRequest?: CustomResolver;
+  resolverMainFields: ReadonlyArray<string>;
+  sourceExts: ReadonlyArray<string>;
+  unstable_enableSymlinks: boolean;
+  unstable_conditionNames: ReadonlyArray<string>;
+  unstable_conditionsByPlatform: Readonly<{
+    [platform: string]: ReadonlyArray<string>;
+  }>;
+  unstable_enablePackageExports: boolean;
+  useWatchman: boolean;
+  requireCycleIgnorePatterns: ReadonlyArray<RegExp>;
+}
+
+export interface SerializerConfigT {
+  createModuleIdFactory: () => (path: string) => number;
+  customSerializer:
+    | ((
+        entryPoint: string,
+        preModules: ReadonlyArray<Module>,
+        graph: ReadOnlyGraph,
+        options: SerializerOptions,
+      ) => Promise<string | {code: string; map: string}>)
+    | null;
+  experimentalSerializerHook: (
+    graph: ReadOnlyGraph,
+    delta: DeltaResult,
+  ) => unknown;
+  getModulesRunBeforeMainModule: (entryFilePath: string) => string[];
+  getPolyfills: (options: {platform: string | null}) => ReadonlyArray<string>;
+  getRunModuleStatement: (moduleId: number | string) => string;
+  polyfillModuleNames: ReadonlyArray<string>;
+  processModuleFilter: (modules: Module) => boolean;
+}
+
+export interface TransformerConfigT extends JsTransformerConfig {
+  getTransformOptions: GetTransformOptions;
+  transformVariants: Readonly<{[name: string]: unknown}>;
+  workerPath: string;
+  publicPath: string;
+}
+
+export interface MetalConfigT {
+  cacheStores: ReadonlyArray<CacheStore<TransformResult>>;
+  cacheVersion: string;
+  fileMapCacheDirectory?: string;
+  /** Deprecated, alias of fileMapCacheDirectory */
+  hasteMapCacheDirectory?: string;
+  maxWorkers: number;
+  unstable_perfLoggerFactory?: PerfLoggerFactory | null;
+  projectRoot: string;
+  stickyWorkers: boolean;
+  transformerPath: string;
+  reporter: Reporter;
+  resetCache: boolean;
+  watchFolders: ReadonlyArray<string>;
+}
+
+export interface ServerConfigT {
+  enhanceMiddleware: (middleware: Middleware, server: Server) => Middleware;
+  experimentalImportBundleSupport: boolean;
+  port: number;
+  rewriteRequestUrl: (url: string) => string;
+  runInspectorProxy: boolean;
+  unstable_serverRoot: string | null;
+  useGlobalHotkey: boolean;
+  verifyConnections: boolean;
+}
+
+export interface SymbolicatorConfigT {
+  customizeFrame: (frame: {
+    readonly file?: string;
+    readonly lineNumber?: number;
+    readonly column?: number;
+    readonly methodName?: string;
+  }) =>
+    | {readonly collapse?: boolean}
+    | undefined
+    | Promise<{readonly collapse?: boolean}>
+    | Promise<undefined>;
+}
+
+export interface WatcherConfigT {
+  additionalExts: ReadonlyArray<string>;
+  watchman: {
+    deferStates: ReadonlyArray<string>;
+  };
+  healthCheck: {
+    enabled: boolean;
+    interval: number;
+    timeout: number;
+    filePrefix: string;
+  };
+}
+
+export interface WatcherInputConfigT
+  extends Partial<Omit<WatcherConfigT, 'healthCheck'>> {
+  healthCheck?: Partial<WatcherConfigT['healthCheck']>;
+}
+
+export interface InputConfigT
+  extends Partial<Omit<MetalConfigT, 'cacheStores'>> {
+  readonly cacheStores?:
+    | ReadonlyArray<CacheStore<TransformResult>>
+    | ((metroCache: MetroCache) => ReadonlyArray<CacheStore<TransformResult>>);
+  readonly resolver?: Partial<ResolverConfigT>;
+  readonly server?: Partial<ServerConfigT>;
+  readonly serializer?: Partial<SerializerConfigT>;
+  readonly symbolicator?: Partial<SymbolicatorConfigT>;
+  readonly transformer?: Partial<TransformerConfigT>;
+  readonly watcher?: Partial<WatcherInputConfigT>;
+}
+
+export type MetroConfig = InputConfigT;
+
+export interface IntermediateConfigT extends MetalConfigT {
+  resolver: ResolverConfigT;
+  server: ServerConfigT;
+  serializer: SerializerConfigT;
+  symbolicator: SymbolicatorConfigT;
+  transformer: TransformerConfigT;
+  watcher: WatcherConfigT;
+}
+
+export interface ConfigT extends Readonly<MetalConfigT> {
+  readonly resolver: Readonly<ResolverConfigT>;
+  readonly server: Readonly<ServerConfigT>;
+  readonly serializer: Readonly<SerializerConfigT>;
+  readonly symbolicator: Readonly<SymbolicatorConfigT>;
+  readonly transformer: Readonly<TransformerConfigT>;
+  readonly watcher: Readonly<WatcherConfigT>;
+}
+
+export interface YargArguments {
+  config?: string;
+  cwd?: string;
+  port?: string | number;
+  host?: string;
+  projectRoot?: string;
+  watchFolders?: string[];
+  assetExts?: string[];
+  sourceExts?: string[];
+  platforms?: string[];
+  'max-workers'?: string | number;
+  maxWorkers?: string | number;
+  transformer?: string;
+  'reset-cache'?: boolean;
+  resetCache?: boolean;
+  runInspectorProxy?: boolean;
+  verbose?: boolean;
+}

packages/metro-config/types/defaults/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * @oncall react_native
+ */
+
+import type {ConfigT} from '../configTypes';
+
+export default interface getDefaultConfig {
+  (rootPath: string | null): Promise<ConfigT>;
+  getDefaultValues: (rootPath: string | null) => ConfigT;
+}

packages/metro-config/types/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * @oncall react_native
+ */
+
+import getDefaultConfig from './defaults';
+import {loadConfig, mergeConfig, resolveConfig} from './loadConfig';
+
+export * from './configTypes';
+export {loadConfig, mergeConfig, resolveConfig, getDefaultConfig};

packages/metro-config/types/loadConfig.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * @oncall react_native
+ */
+
+import type {ConfigT, InputConfigT, YargArguments} from './configTypes';
+
+export interface CosmiConfigResult {
+  filepath: string;
+  isEmpty: boolean;
+  config:
+    | ((partialConfig: ConfigT) => Promise<ConfigT>)
+    | ((partialConfig: ConfigT) => ConfigT)
+    | InputConfigT;
+}
+
+export function loadConfig(
+  argv?: YargArguments,
+  defaultConfigOverrides?: InputConfigT,
+): Promise<ConfigT>;
+
+export function resolveConfig(
+  filePath?: string,
+  cwd?: string,
+): Promise<ConfigT>;
+
+export function mergeConfig(
+  defaultConfig: InputConfigT,
+  ...configs: InputConfigT[]
+): ConfigT;