metro-file-map 0.84.0 → 0.84.2

package/src/plugins/DependencyPlugin.js

@@ -28,7 +28,7 @@ class DependencyPlugin {
   getSerializableSnapshot() {
     return null;
   }
-  async bulkUpdate(delta) {}
+  bulkUpdate(delta) {}
   onNewOrModifiedFile(relativeFilePath, pluginData) {}
   onRemovedFile(relativeFilePath, pluginData) {}
   assertValid() {}

package/src/plugins/DependencyPlugin.js.flow

@@ -64,7 +64,7 @@ export default class DependencyPlugin
     return null;
   }
 
-  async bulkUpdate(delta: FileMapDelta<?ReadonlyArray<string>>): Promise<void> {
+  bulkUpdate(delta: FileMapDelta<?ReadonlyArray<string>>): void {
     // No-op: Worker already populated plugin data
     // Plugin data is write-only from worker
   }

package/src/plugins/HastePlugin.d.ts

@@ -0,0 +1,77 @@
+/**
+ * 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<<c8bc637264c4155765c375a0f0971803>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/plugins/HastePlugin.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {
+  Console,
+  FileMapDelta,
+  FileMapPlugin,
+  FileMapPluginInitOptions,
+  FileMapPluginWorker,
+  HasteConflict,
+  HasteMap,
+  HasteMapItemMetadata,
+  HTypeValue,
+  Path,
+  PerfLogger,
+} from '../flow-types';
+
+export type HasteMapOptions = Readonly<{
+  console?: null | undefined | Console;
+  enableHastePackages: boolean;
+  hasteImplModulePath: null | undefined | string;
+  perfLogger?: null | undefined | PerfLogger;
+  platforms: ReadonlySet<string>;
+  rootDir: Path;
+  failValidationOnConflicts: boolean;
+}>;
+declare class HastePlugin
+  implements HasteMap, FileMapPlugin<null, string | null>
+{
+  readonly name: 'haste';
+  constructor(options: HasteMapOptions);
+  initialize(
+    $$PARAM_0$$: FileMapPluginInitOptions<null, string | null>,
+  ): Promise<void>;
+  getSerializableSnapshot(): null;
+  getModule(
+    name: string,
+    platform?: null | undefined | string,
+    supportsNativePlatform?: null | undefined | boolean,
+    type?: null | undefined | HTypeValue,
+  ): null | undefined | Path;
+  getModuleNameByPath(mixedPath: Path): null | undefined | string;
+  getPackage(
+    name: string,
+    platform: null | undefined | string,
+    _supportsNativePlatform?: null | undefined | boolean,
+  ): null | undefined | Path;
+  bulkUpdate(delta: FileMapDelta<null | undefined | string>): void;
+  onNewOrModifiedFile(
+    relativeFilePath: string,
+    id: null | undefined | string,
+  ): void;
+  setModule(id: string, module: HasteMapItemMetadata): void;
+  onRemovedFile(
+    relativeFilePath: string,
+    moduleName: null | undefined | string,
+  ): void;
+  assertValid(): void;
+  computeConflicts(): Array<HasteConflict>;
+  getCacheKey(): string;
+  getWorker(): FileMapPluginWorker;
+}
+export default HastePlugin;

package/src/plugins/HastePlugin.js

@@ -163,7 +163,7 @@ class HastePlugin {
       duplicates,
     );
   }
-  async bulkUpdate(delta) {
+  bulkUpdate(delta) {
     for (const [normalPath, maybeHasteId] of delta.removed) {
       this.onRemovedFile(normalPath, maybeHasteId);
     }

package/src/plugins/HastePlugin.js.flow

@@ -237,7 +237,7 @@ export default class HastePlugin
     );
   }
 
-  async bulkUpdate(delta: FileMapDelta<?string>): Promise<void> {
+  bulkUpdate(delta: FileMapDelta<?string>): void {
     // Process removals first so that moves aren't treated as duplicates.
     for (const [normalPath, maybeHasteId] of delta.removed) {
       this.onRemovedFile(normalPath, maybeHasteId);

package/src/plugins/MockPlugin.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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<<81805d051693b746e75928fe6ed3dbca>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/plugins/MockPlugin.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {
+  FileMapDelta,
+  FileMapPlugin,
+  FileMapPluginInitOptions,
+  FileMapPluginWorker,
+  MockMap as IMockMap,
+  Path,
+  RawMockMap,
+} from '../flow-types';
+
+export declare const CACHE_VERSION: 2;
+export declare type CACHE_VERSION = typeof CACHE_VERSION;
+export type MockMapOptions = Readonly<{
+  console: typeof console;
+  mocksPattern: RegExp;
+  rawMockMap?: RawMockMap;
+  rootDir: Path;
+  throwOnModuleCollision: boolean;
+}>;
+declare class MockPlugin implements FileMapPlugin<RawMockMap, void>, IMockMap {
+  readonly name: 'mocks';
+  constructor($$PARAM_0$$: MockMapOptions);
+  initialize($$PARAM_0$$: FileMapPluginInitOptions<RawMockMap>): Promise<void>;
+  getMockModule(name: string): null | undefined | Path;
+  bulkUpdate(delta: FileMapDelta): void;
+  onNewOrModifiedFile(relativeFilePath: Path): void;
+  onRemovedFile(relativeFilePath: Path): void;
+  getSerializableSnapshot(): RawMockMap;
+  assertValid(): void;
+  getCacheKey(): string;
+  getWorker(): null | undefined | FileMapPluginWorker;
+}
+export default MockPlugin;

package/src/plugins/MockPlugin.js

@@ -51,7 +51,7 @@ class MockPlugin {
     if (pluginState != null && pluginState.version === this.#raw.version) {
       this.#raw = pluginState;
     } else {
-      await this.bulkUpdate({
+      this.bulkUpdate({
         addedOrModified: [
           ...files.fileIterator({
             includeNodeModules: false,
@@ -72,7 +72,7 @@ class MockPlugin {
       (0, _normalizePathSeparatorsToSystem.default)(mockPosixRelativePath),
     );
   }
-  async bulkUpdate(delta) {
+  bulkUpdate(delta) {
     for (const [relativeFilePath] of delta.removed) {
       this.onRemovedFile(relativeFilePath);
     }

package/src/plugins/MockPlugin.js.flow

@@ -79,7 +79,7 @@ export default class MockPlugin
       this.#raw = pluginState;
     } else {
       // Otherwise, traverse all files to rebuild
-      await this.bulkUpdate({
+      this.bulkUpdate({
         addedOrModified: [
           ...files.fileIterator({
             includeNodeModules: false,
@@ -102,7 +102,7 @@ export default class MockPlugin
     );
   }
 
-  async bulkUpdate(delta: FileMapDelta<>): Promise<void> {
+  bulkUpdate(delta: FileMapDelta<>): void {
     // Process removals first so that moves aren't treated as duplicates.
     for (const [relativeFilePath] of delta.removed) {
       this.onRemovedFile(relativeFilePath);

package/src/plugins/dependencies/dependencyExtractor.d.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @format
+ * @generated by js1 build metro-ts-defs / yarn run build-ts-defs
  */
 
 declare const dependencyExtractor: {

package/src/plugins/haste/DuplicateHasteCandidatesError.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<<2c991103bc4a71a81ef04de0884de576>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/plugins/haste/DuplicateHasteCandidatesError.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {DuplicatesSet} from '../../flow-types';
+
+export declare class DuplicateHasteCandidatesError extends Error {
+  hasteName: string;
+  platform: string | null;
+  supportsNativePlatform: boolean;
+  duplicatesSet: DuplicatesSet;
+  constructor(
+    name: string,
+    platform: string,
+    supportsNativePlatform: boolean,
+    duplicatesSet: DuplicatesSet,
+  );
+}

package/src/plugins/haste/HasteConflictsError.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<<53c103ffe2115282c4d72593f47018aa>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/plugins/haste/HasteConflictsError.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {HasteConflict} from '../../flow-types';
+
+export declare class HasteConflictsError extends Error {
+  constructor(conflicts: ReadonlyArray<HasteConflict>);
+  getDetailedMessage(pathsRelativeToRoot: null | undefined | string): string;
+}

package/src/plugins/haste/computeConflicts.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
+ * @generated SignedSource<<f56c9fdb2fc1c692fa880c61a14ba1e3>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/plugins/haste/computeConflicts.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {HasteMapItem} from '../../flow-types';
+
+type Conflict = {
+  id: string;
+  platform: string | null;
+  absolutePaths: Array<string>;
+  type: 'duplicate' | 'shadowing';
+};
+export declare function computeHasteConflicts(
+  options: Readonly<{
+    duplicates: ReadonlyMap<
+      string,
+      ReadonlyMap<string, ReadonlyMap<string, number>>
+    >;
+    map: ReadonlyMap<string, HasteMapItem>;
+    rootDir: string;
+  }>,
+): Array<Conflict>;

package/src/plugins/haste/getPlatformExtension.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<<3d628d7c2b6149348fcdc5782fc24bb7>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/plugins/haste/getPlatformExtension.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+declare function getPlatformExtension(
+  file: string,
+  platforms: ReadonlySet<string>,
+): null | undefined | string;
+export default getPlatformExtension;

package/src/plugins/mocks/getMockName.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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<<1c1794b89fa69eff13b6cd80bf0ab42d>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/plugins/mocks/getMockName.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+declare const $$EXPORT_DEFAULT_DECLARATION$$: (filePath: string) => string;
+declare type $$EXPORT_DEFAULT_DECLARATION$$ =
+  typeof $$EXPORT_DEFAULT_DECLARATION$$;
+export default $$EXPORT_DEFAULT_DECLARATION$$;

package/src/watchers/AbstractWatcher.d.ts

@@ -0,0 +1,41 @@
+/**
+ * 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<<ba8a5de14ca08c751a87bea6b356a670>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/watchers/AbstractWatcher.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {
+  WatcherBackend,
+  WatcherBackendChangeEvent,
+  WatcherBackendOptions,
+} from '../flow-types';
+
+export type Listeners = Readonly<{
+  onFileEvent: (event: WatcherBackendChangeEvent) => void;
+  onError: (error: Error) => void;
+}>;
+export declare class AbstractWatcher implements WatcherBackend {
+  readonly root: string;
+  readonly ignored: null | undefined | RegExp;
+  readonly globs: ReadonlyArray<string>;
+  readonly dot: boolean;
+  readonly doIgnore: (path: string) => boolean;
+  constructor(dir: string, opts: WatcherBackendOptions);
+  onFileEvent(listener: (event: WatcherBackendChangeEvent) => void): () => void;
+  onError(listener: (error: Error) => void): () => void;
+  startWatching(): Promise<void>;
+  stopWatching(): Promise<void>;
+  emitFileEvent(event: Omit<WatcherBackendChangeEvent, 'root'>): void;
+  emitError(error: Error): void;
+  getPauseReason(): null | undefined | string;
+}

package/src/watchers/FallbackWatcher.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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<<5152d1919d3373e4df611e0fca805e1c>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/watchers/FallbackWatcher.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import {AbstractWatcher} from './AbstractWatcher';
+
+declare class FallbackWatcher extends AbstractWatcher {
+  startWatching(): Promise<void>;
+  /**
+   * End watching.
+   */
+  stopWatching(): Promise<void>;
+  getPauseReason(): null | undefined | string;
+}
+export default FallbackWatcher;

package/src/watchers/NativeWatcher.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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<<8239479487abff6df70ee54f9e05f352>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/watchers/NativeWatcher.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import {AbstractWatcher} from './AbstractWatcher';
+/**
+ * NativeWatcher uses Node's native fs.watch API with recursive: true.
+ *
+ * Supported on macOS (and potentially Windows), because both natively have a
+ * concept of recurisve watching, via FSEvents and ReadDirectoryChangesW
+ * respectively. Notably Linux lacks this capability at the OS level.
+ *
+ * Node.js has at times supported the `recursive` option to fs.watch on Linux
+ * by walking the directory tree and creating a watcher on each directory, but
+ * this fits poorly with the synchronous `watch` API - either it must block for
+ * arbitrarily large IO, or it may drop changes after `watch` returns. See:
+ * https://github.com/nodejs/node/issues/48437
+ *
+ * Therefore, we retain a fallback to our own application-level recursive
+ * FallbackWatcher for Linux, which has async `startWatching`.
+ *
+ * On Windows, this watcher could be used in principle, but needs work around
+ * some Windows-specific edge cases handled in FallbackWatcher, like
+ * deduping file change events, ignoring directory changes, and handling EPERM.
+ */
+declare class NativeWatcher extends AbstractWatcher {
+  static isSupported(): boolean;
+  constructor(
+    dir: string,
+    opts: Readonly<{
+      ignored: null | undefined | RegExp;
+      globs: ReadonlyArray<string>;
+      dot: boolean;
+    }>,
+  );
+  startWatching(): Promise<void>;
+  /**
+   * End watching.
+   */
+  stopWatching(): Promise<void>;
+  _handleEvent(relativePath: string): void;
+}
+export default NativeWatcher;

package/src/watchers/RecrawlWarning.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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<<dc063c7e351d5c09a5ad65d09b5b6b2a>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/watchers/RecrawlWarning.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+/**
+ * Originally vendored from
+ * https://github.com/amasad/sane/blob/64ff3a870c42e84f744086884bf55a4f9c22d376/src/utils/recrawl-warning-dedupe.js
+ */
+
+declare class RecrawlWarning {
+  static RECRAWL_WARNINGS: Array<RecrawlWarning>;
+  static REGEXP: RegExp;
+  root: string;
+  count: number;
+  constructor(root: string, count: number);
+  static findByRoot(root: string): null | undefined | RecrawlWarning;
+  static isRecrawlWarningDupe(warningMessage: unknown): boolean;
+}
+export default RecrawlWarning;

package/src/watchers/WatchmanWatcher.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<<b8358b8822835bcef505207f90b02c66>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/watchers/WatchmanWatcher.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {WatcherOptions} from './common';
+
+import {AbstractWatcher} from './AbstractWatcher';
+/**
+ * Watches `dir`.
+ */
+declare class WatchmanWatcher extends AbstractWatcher {
+  readonly subscriptionName: string;
+  constructor(dir: string, opts: WatcherOptions);
+  startWatching(): Promise<void>;
+  /**
+   * Closes the watcher.
+   */
+  stopWatching(): Promise<void>;
+  getPauseReason(): null | undefined | string;
+}
+export default WatchmanWatcher;

package/src/watchers/common.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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<<4f8f87abcb055b965a90e994a55ed177>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/watchers/common.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+/**
+ * Originally vendored from
+ * https://github.com/amasad/sane/blob/64ff3a870c42e84f744086884bf55a4f9c22d376/src/common.js
+ */
+
+import type {ChangeEventMetadata} from '../flow-types';
+import type {Stats} from 'fs';
+/**
+ * Constants
+ */
+export declare const DELETE_EVENT: 'delete';
+export declare type DELETE_EVENT = typeof DELETE_EVENT;
+export declare const TOUCH_EVENT: 'touch';
+export declare type TOUCH_EVENT = typeof TOUCH_EVENT;
+export declare const ALL_EVENT: 'all';
+export declare type ALL_EVENT = typeof ALL_EVENT;
+export type WatcherOptions = Readonly<{
+  globs: ReadonlyArray<string>;
+  dot: boolean;
+  ignored: null | undefined | RegExp;
+  watchmanDeferStates: ReadonlyArray<string>;
+  watchman?: unknown;
+  watchmanPath?: string;
+}>;
+/**
+ * Checks a file relative path against the globs array.
+ */
+export declare function includedByGlob(
+  type: null | undefined | ('f' | 'l' | 'd'),
+  globs: ReadonlyArray<string>,
+  dot: boolean,
+  relativePath: string,
+): boolean;
+/**
+ * Whether the given filePath matches the given RegExp, after converting
+ * (on Windows only) system separators to posix separators.
+ *
+ * Conversion to posix is for backwards compatibility with the previous
+ * anymatch matcher, which normlises all inputs[1]. This may not be consistent
+ * with other parts of metro-file-map.
+ *
+ * [1]: https://github.com/micromatch/anymatch/blob/3.1.1/index.js#L50
+ */
+export declare const posixPathMatchesPattern: (
+  pattern: RegExp,
+  filePath: string,
+) => boolean;
+export declare type posixPathMatchesPattern = typeof posixPathMatchesPattern;
+export declare function typeFromStat(
+  stat: Stats,
+): null | undefined | ChangeEventMetadata['type'];