metro 0.84.1 → 0.84.3

package/src/lib/getPrependedScripts.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<a85e80b79c0295e96824c17436edfcca>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/lib/getPrependedScripts.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type Bundler from '../Bundler';
+import type {Module, default as DeltaBundler} from '../DeltaBundler';
+import type {TransformInputOptions} from '../DeltaBundler/types';
+import type {ResolverInputOptions} from '../shared/types';
+import type {ConfigT} from 'metro-config';
+
+declare function getPrependedScripts(
+  config: ConfigT,
+  options: Omit<TransformInputOptions, 'type'>,
+  resolverOptions: ResolverInputOptions,
+  bundler: Bundler,
+  deltaBundler: DeltaBundler,
+): Promise<ReadonlyArray<Module>>;
+export default getPrependedScripts;

package/src/lib/isResolvedDependency.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<f1d42fcf747b4fa7641e50b8d4ddc424>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/lib/isResolvedDependency.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {Dependency, ResolvedDependency} from '../DeltaBundler/types';
+
+export declare function isResolvedDependency(
+  dep: Dependency,
+): dep is ResolvedDependency;

package/src/lib/logToConsole.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @generated SignedSource<<95cf7d414507e2035210d06882d858b3>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/lib/logToConsole.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {Terminal} from 'metro-core';
+
+declare const $$EXPORT_DEFAULT_DECLARATION$$: (
+  terminal: Terminal,
+  level: string,
+  ...data: Array<unknown>
+) => void;
+declare type $$EXPORT_DEFAULT_DECLARATION$$ =
+  typeof $$EXPORT_DEFAULT_DECLARATION$$;
+export default $$EXPORT_DEFAULT_DECLARATION$$;

package/src/lib/parseBundleOptionsFromBundleRequestUrl.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<972fc847af4a55ba0e4863c90532e99c>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/lib/parseBundleOptionsFromBundleRequestUrl.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {BundleOptions} from '../shared/types';
+
+declare function parseBundleOptionsFromBundleRequestUrl(
+  rawNonJscSafeUrlEncodedUrl: string,
+  platforms: Set<string>,
+): Omit<BundleOptions, keyof {bundleType: string}> & {bundleType: string};
+export default parseBundleOptionsFromBundleRequestUrl;

package/src/lib/parseCustomResolverOptions.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<e0f212b1e687fef985215d8c152e7c04>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/lib/parseCustomResolverOptions.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {CustomResolverOptions} from 'metro-resolver';
+
+declare function parseCustomResolverOptions(
+  searchParams: URLSearchParams,
+): CustomResolverOptions;
+export default parseCustomResolverOptions;

package/src/lib/parseCustomTransformOptions.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<086e5d861160a99775fa58beba59492a>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/lib/parseCustomTransformOptions.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {CustomTransformOptions} from 'metro-transform-worker';
+
+declare function parseCustomTransformOptions(
+  searchParams: URLSearchParams,
+): CustomTransformOptions;
+export default parseCustomTransformOptions;

package/src/lib/parseJsonBody.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<cd5e7346556814416374b8c8e79a8674>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/lib/parseJsonBody.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {IncomingMessage} from 'http';
+
+export type JsonData =
+  | {[$$Key$$: string]: JsonData}
+  | Array<JsonData>
+  | string
+  | number
+  | boolean
+  | null;
+/**
+ * Attempt to parse a request body as JSON.
+ */
+declare function parseJsonBody(
+  req: IncomingMessage,
+  options?: {strict?: boolean},
+): Promise<JsonData>;
+export default parseJsonBody;

package/src/lib/pathUtils.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @generated SignedSource<<61d935169a7ad0d7f2d7b4c6e4eb0a96>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/lib/pathUtils.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+export declare const normalizePathSeparatorsToPosix: (
+  $$PARAM_0$$: string,
+) => string;
+export declare type normalizePathSeparatorsToPosix =
+  typeof normalizePathSeparatorsToPosix;

package/src/lib/relativizeSourceMap.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<5282fe2c42baa79f957ef2a40bec560b>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/lib/relativizeSourceMap.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {MixedSourceMap} from 'metro-source-map';
+
+declare function relativizeSourceMapInline(
+  sourceMap: MixedSourceMap,
+  sourcesRoot: string,
+): void;
+export default relativizeSourceMapInline;

package/src/lib/reporting.d.ts

@@ -0,0 +1,135 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<1ff95f1ad6bb911f3d2c2bc41d59bc1a>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/lib/reporting.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {Terminal} from 'metro-core';
+import type {HealthCheckResult, WatcherStatus} from 'metro-file-map';
+import type {CustomResolverOptions} from 'metro-resolver';
+import type {CustomTransformOptions} from 'metro-transform-worker';
+
+export type BundleDetails = {
+  bundleType: string;
+  customResolverOptions: CustomResolverOptions;
+  customTransformOptions: CustomTransformOptions;
+  dev: boolean;
+  entryFile: string;
+  minify: boolean;
+  platform: null | undefined | string;
+};
+/**
+ * A tagged union of all the actions that may happen and we may want to
+ * report to the tool user.
+ */
+export type ReportableEvent =
+  | {port: number; hasReducedPerformance: boolean; type: 'initialize_started'}
+  | {type: 'initialize_failed'; port: number; error: Error}
+  | {type: 'initialize_done'; port: number}
+  | {buildID: string; type: 'bundle_build_done'}
+  | {buildID: string; type: 'bundle_build_failed'}
+  | {type: 'bundle_save_log'; message: string}
+  | {
+      buildID: string;
+      bundleDetails: BundleDetails;
+      isPrefetch?: boolean;
+      type: 'bundle_build_started';
+    }
+  | {error: Error; type: 'bundling_error'}
+  | {type: 'dep_graph_loading'; hasReducedPerformance: boolean}
+  | {type: 'dep_graph_loaded'}
+  | {
+      buildID: string;
+      type: 'bundle_transform_progressed';
+      transformedFileCount: number;
+      totalFileCount: number;
+    }
+  | {type: 'cache_read_error'; error: Error}
+  | {type: 'cache_write_error'; error: Error}
+  | {type: 'transform_cache_reset'}
+  | {type: 'worker_stdout_chunk'; chunk: string}
+  | {type: 'worker_stderr_chunk'; chunk: string}
+  | {type: 'hmr_client_error'; error: Error}
+  | {
+      type: 'client_log';
+      level:
+        | 'trace'
+        | 'info'
+        | 'warn'
+        | 'log'
+        | 'group'
+        | 'groupCollapsed'
+        | 'groupEnd'
+        | 'debug';
+      data: Array<unknown>;
+    }
+  | {type: 'resolver_warning'; message: string}
+  | {type: 'server_listening'; port: number; address: string; family: string}
+  | {type: 'transformer_load_started'}
+  | {type: 'transformer_load_done'}
+  | {type: 'transformer_load_failed'; error: Error}
+  | {type: 'watcher_health_check_result'; result: HealthCheckResult}
+  | {type: 'watcher_status'; status: WatcherStatus};
+/**
+ * Code across the application takes a reporter as an option and calls the
+ * update whenever one of the ReportableEvent happens. Code does not directly
+ * write to the standard output, because a build would be:
+ *
+ *   1. ad-hoc, embedded into another tool, in which case we do not want to
+ *   pollute that tool's own output. The tool is free to present the
+ *   warnings/progress we generate any way they want, by specifing a custom
+ *   reporter.
+ *   2. run as a background process from another tool, in which case we want
+ *   to expose updates in a way that is easily machine-readable, for example
+ *   a JSON-stream. We don't want to pollute it with textual messages.
+ *
+ * We centralize terminal reporting into a single place because we want the
+ * output to be robust and consistent. The most common reporter is
+ * TerminalReporter, that should be the only place in the application should
+ * access the `terminal` module (nor the `console`).
+ */
+export type Reporter = {update(event: ReportableEvent): void};
+/**
+ * A standard way to log a warning to the terminal. This should not be called
+ * from some arbitrary Metro logic, only from the reporters. Instead of
+ * calling this, add a new type of ReportableEvent instead, and implement a
+ * proper handler in the reporter(s).
+ */
+export declare function logWarning(
+  terminal: Terminal,
+  format: string,
+  ...args: Array<unknown>
+): void;
+/**
+ * Similar to `logWarning`, but for messages that require the user to act.
+ */
+export declare function logError(
+  terminal: Terminal,
+  format: string,
+  ...args: Array<unknown>
+): void;
+/**
+ * Similar to `logWarning`, but for informational messages.
+ */
+export declare function logInfo(
+  terminal: Terminal,
+  format: string,
+  ...args: Array<unknown>
+): void;
+/**
+ * A reporter that does nothing. Errors and warnings will be swallowed, that
+ * is generally not what you want.
+ */
+export declare const nullReporter: {update(): void};
+export declare type nullReporter = typeof nullReporter;

package/src/lib/splitBundleOptions.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<cf1e935fe7a5b1c8573b53b1c1921e70>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/lib/splitBundleOptions.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {BundleOptions, SplitBundleOptions} from '../shared/types';
+/**
+ * Splits a BundleOptions object into smaller, more manageable parts.
+ */
+declare function splitBundleOptions(options: BundleOptions): SplitBundleOptions;
+export default splitBundleOptions;

package/src/lib/transformHelpers.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<dfdfdf9ddb80994cc031e3767a87b56f>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/lib/transformHelpers.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type Bundler from '../Bundler';
+import type {TransformFn, default as DeltaBundler} from '../DeltaBundler';
+import type {
+  BundlerResolution,
+  TransformInputOptions,
+  TransformResultDependency,
+} from '../DeltaBundler/types';
+import type {ResolverInputOptions} from '../shared/types';
+import type {ConfigT} from 'metro-config';
+
+export declare function getTransformFn(
+  entryFiles: ReadonlyArray<string>,
+  bundler: Bundler,
+  deltaBundler: DeltaBundler,
+  config: ConfigT,
+  options: TransformInputOptions,
+  resolverOptions: ResolverInputOptions,
+): Promise<TransformFn>;
+export declare function getResolveDependencyFn(
+  bundler: Bundler,
+  platform: null | undefined | string,
+  resolverOptions: ResolverInputOptions,
+): Promise<
+  (from: string, dependency: TransformResultDependency) => BundlerResolution
+>;

package/src/node-haste/DependencyGraph/ModuleResolution.d.ts

@@ -0,0 +1,120 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<0024fd05b95efe19a24f9acc84ff474b>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/node-haste/DependencyGraph/ModuleResolution.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {
+  BundlerResolution,
+  TransformResultDependency,
+} from '../../DeltaBundler/types';
+import type {Reporter} from '../../lib/reporting';
+import type {ResolverInputOptions} from '../../shared/types';
+import type {
+  CustomResolver,
+  DoesFileExist,
+  FileCandidates,
+  FileSystemLookup,
+  Resolution,
+  ResolveAsset,
+} from 'metro-resolver';
+import type {PackageForModule, PackageJson} from 'metro-resolver/private/types';
+
+export type DirExistsFn = (filePath: string) => boolean;
+type Options = Readonly<{
+  assetExts: ReadonlySet<string>;
+  dirExists: DirExistsFn;
+  disableHierarchicalLookup: boolean;
+  doesFileExist: DoesFileExist;
+  emptyModulePath: string;
+  extraNodeModules: null | undefined | object;
+  fileSystemLookup: FileSystemLookup;
+  getHasteModulePath: (
+    name: string,
+    platform: null | undefined | string,
+  ) => null | undefined | string;
+  getHastePackagePath: (
+    name: string,
+    platform: null | undefined | string,
+  ) => null | undefined | string;
+  mainFields: ReadonlyArray<string>;
+  getPackage: (packageJsonPath: string) => null | undefined | PackageJson;
+  getPackageForModule: (
+    absolutePath: string,
+  ) => null | undefined | PackageForModule;
+  nodeModulesPaths: ReadonlyArray<string>;
+  preferNativePlatform: boolean;
+  projectRoot: string;
+  reporter: Reporter;
+  resolveAsset: ResolveAsset;
+  resolveRequest: null | undefined | CustomResolver;
+  sourceExts: ReadonlyArray<string>;
+  unstable_conditionNames: ReadonlyArray<string>;
+  unstable_conditionsByPlatform: Readonly<{
+    [platform: string]: ReadonlyArray<string>;
+  }>;
+  unstable_enablePackageExports: boolean;
+  unstable_incrementalResolution: boolean;
+}>;
+export declare class ModuleResolver {
+  _options: Options;
+  _projectRootFakeModulePath: string;
+  _cachedEmptyModule: null | undefined | BundlerResolution;
+  constructor(options: Options);
+  _getEmptyModule(): BundlerResolution;
+  resolveDependency(
+    originModulePath: string,
+    dependency: TransformResultDependency,
+    allowHaste: boolean,
+    platform: string | null,
+    resolverOptions: ResolverInputOptions,
+  ): BundlerResolution;
+  /**
+   * TODO: Return Resolution instead of coercing to BundlerResolution here
+   */
+  _getFileResolvedModule(resolution: Resolution): BundlerResolution;
+  _logWarning: (message: string) => void;
+  _removeRoot(candidates: FileCandidates): FileCandidates;
+}
+export declare class UnableToResolveError extends Error {
+  /**
+   * File path of the module that tried to require a module, ex. `/js/foo.js`.
+   */
+  originModulePath: string;
+  /**
+   * The name of the module that was required, no necessarily a path,
+   * ex. `./bar`, or `invariant`.
+   */
+  targetModuleName: string;
+  /**
+   * Original error that causes this error
+   */
+  cause: null | undefined | Error;
+  /**
+   * Fixed type field in common with other Metro build errors.
+   */
+  readonly type: 'UnableToResolveError';
+  constructor(
+    originModulePath: string,
+    targetModuleName: string,
+    message: string,
+    options?: Readonly<{
+      dependency?: null | undefined | TransformResultDependency;
+      cause?: Error;
+    }>,
+  );
+  buildCodeFrameMessage(
+    dependency: null | undefined | TransformResultDependency,
+  ): null | undefined | string;
+}

package/src/node-haste/DependencyGraph/ModuleResolution.js

@@ -86,6 +86,8 @@ class ModuleResolver {
       doesFileExist,
       extraNodeModules,
       fileSystemLookup,
+      getPackage,
+      getPackageForModule,
       mainFields,
       nodeModulesPaths,
       preferNativePlatform,
@@ -109,9 +111,8 @@ class ModuleResolver {
             doesFileExist,
             extraNodeModules,
             fileSystemLookup,
-            getPackage: this._getPackage,
-            getPackageForModule: (absoluteModulePath) =>
-              this._getPackageForModule(absoluteModulePath),
+            getPackage,
+            getPackageForModule,
             isESMImport: dependency.data.isESMImport,
             mainFields,
             nodeModulesPaths,
@@ -191,25 +192,6 @@ class ModuleResolver {
       throw error;
     }
   }
-  _getPackage = (packageJsonPath) => {
-    try {
-      return this._options.packageCache.getPackage(packageJsonPath).read();
-    } catch (e) {}
-    return null;
-  };
-  _getPackageForModule = (absolutePath) => {
-    let result;
-    try {
-      result = this._options.packageCache.getPackageOf(absolutePath);
-    } catch (e) {}
-    return result != null
-      ? {
-          packageJson: result.pkg.read(),
-          packageRelativePath: result.packageRelativePath,
-          rootPath: _path.default.dirname(result.pkg.path),
-        }
-      : null;
-  };
   _getFileResolvedModule(resolution) {
     switch (resolution.type) {
       case "sourceFile":