metro-file-map 0.83.5 → 0.83.6

package/src/flow-types.d.ts

@@ -4,8 +4,15 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @format
+ * @noformat
  * @oncall react_native
+ * @generated SignedSource<<b3646c81d37188726a1fc27777dcbede>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/flow-types.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
  */
 
 import type {PerfLogger, PerfLoggerFactory, RootPerfLogger} from 'metro-config';
@@ -17,7 +24,7 @@ export type BuildParameters = Readonly<{
   extensions: ReadonlyArray<string>;
   forceNodeFilesystemAPI: boolean;
   ignorePattern: RegExp;
-  plugins: ReadonlyArray<FileMapPlugin>;
+  plugins: ReadonlyArray<InputFileMapPlugin>;
   retainAllFiles: boolean;
   rootDir: string;
   roots: ReadonlyArray<string>;
@@ -68,10 +75,15 @@ export type CacheManagerWriteOptions = Readonly<{
   onWriteError: (error: Error) => void;
 }>;
 export type CanonicalPath = string;
-export type ChangeEvent = {
+export type ChangedFileMetadata = Readonly<{
+  isSymlink: boolean;
+  modifiedTime?: null | undefined | number;
+}>;
+export type ChangeEvent = Readonly<{
   logger: null | undefined | RootPerfLogger;
-  eventsQueue: EventsQueue;
-};
+  changes: ReadonlyFileSystemChanges<Readonly<ChangedFileMetadata>>;
+  rootDir: string;
+}>;
 export type ChangeEventMetadata = {
   modifiedTime: null | undefined | number;
   size: null | undefined | number;
@@ -94,7 +106,11 @@ export type CrawlerOptions = {
   rootDir: string;
   roots: ReadonlyArray<string>;
   onStatus: (status: WatcherStatus) => void;
+  subpath?: string;
 };
+export type CrawlResult =
+  | {changedFiles: FileData; removedFiles: Set<Path>; clocks: WatchmanClocks}
+  | {changedFiles: FileData; removedFiles: Set<Path>};
 export type DependencyExtractor = {
   extract: (
     content: string,
@@ -121,15 +137,6 @@ export type WatcherStatus =
     };
 export type DuplicatesSet = Map<string, number>;
 export type DuplicatesIndex = Map<string, Map<string, DuplicatesSet>>;
-export type EventsQueue = Array<{
-  filePath: Path;
-  metadata: ChangeEventMetadata;
-  type: string;
-}>;
-export type FileMapDelta<T = null | void> = Readonly<{
-  removed: Iterable<[CanonicalPath, T]>;
-  addedOrModified: Iterable<[CanonicalPath, T]>;
-}>;
 export type FileMapPluginInitOptions<
   SerializableState,
   PerFileData = void,
@@ -140,13 +147,13 @@ export type FileMapPluginInitOptions<
     ): Iterable<{
       baseName: string;
       canonicalPath: string;
-      pluginData: null | undefined | PerFileData;
+      readonly pluginData: null | undefined | PerFileData;
     }>;
     lookup(
       mixedPath: string,
     ):
       | {exists: false}
-      | {exists: true; type: 'f'; pluginData: PerFileData}
+      | {exists: true; type: 'f'; readonly pluginData: PerFileData}
       | {exists: true; type: 'd'};
   }>;
   pluginState: null | undefined | SerializableState;
@@ -176,19 +183,25 @@ export interface FileMapPlugin<
     initOptions: FileMapPluginInitOptions<SerializableState, PerFileData>,
   ): Promise<void>;
   assertValid(): void;
-  bulkUpdate(delta: FileMapDelta<null | undefined | PerFileData>): void;
-  getSerializableSnapshot(): SerializableState;
-  onRemovedFile(
-    relativeFilePath: string,
-    pluginData: null | undefined | PerFileData,
-  ): void;
-  onNewOrModifiedFile(
-    relativeFilePath: string,
-    pluginData: null | undefined | PerFileData,
+  onChanged(
+    changes: ReadonlyFileSystemChanges<null | undefined | PerFileData>,
   ): void;
+  getSerializableSnapshot(): void | V8Serializable;
   getCacheKey(): string;
   getWorker(): null | undefined | FileMapPluginWorker;
 }
+export type InputFileMapPlugin = FileMapPlugin<
+  /**
+   * > 235 | export type InputFileMapPlugin = FileMapPlugin<empty, empty>;
+   *       |                                                ^^^^^ Unsupported feature: Translating "empty type" is currently not supported.
+   **/
+  any,
+  /**
+   * > 235 | export type InputFileMapPlugin = FileMapPlugin<empty, empty>;
+   *       |                                                       ^^^^^ Unsupported feature: Translating "empty type" is currently not supported.
+   **/
+  any
+>;
 export interface MetadataWorker {
   processFile(
     $$PARAM_0$$: WorkerMessage,
@@ -228,10 +241,22 @@ export type FileStats = Readonly<{
 export interface FileSystem {
   exists(file: Path): boolean;
   getAllFiles(): Array<Path>;
-  getDifference(files: FileData): {
-    changedFiles: FileData;
-    removedFiles: Set<string>;
-  };
+  /**
+   * Given a map of files, determine which of them are new or modified
+   * (changedFiles), and which of them are missing from the input
+   * (removedFiles), vs the current state of this instance of FileSystem.
+   */
+  getDifference(
+    files: FileData,
+    options?: Readonly<{
+      /**
+       * Only consider files under this subpath (which should be a directory)
+       * when computing removedFiles. If not provided, all files in the file
+       * system are considered.
+       */
+      subpath?: string;
+    }>,
+  ): {changedFiles: FileData; removedFiles: Set<string>};
   getSerializableSnapshot(): CacheData['fileSystemData'];
   getSha1(file: Path): null | undefined | string;
   getOrComputeSha1(
@@ -335,10 +360,35 @@ export type HasteMapItem = {
   [platform: string]: HasteMapItemMetadata;
 };
 export type HasteMapItemMetadata = [string, number];
+export interface FileSystemListener {
+  directoryAdded(canonicalPath: CanonicalPath): void;
+  directoryRemoved(canonicalPath: CanonicalPath): void;
+  fileAdded(canonicalPath: CanonicalPath, data: FileMetadata): void;
+  fileModified(
+    canonicalPath: CanonicalPath,
+    oldData: FileMetadata,
+    newData: FileMetadata,
+  ): void;
+  fileRemoved(canonicalPath: CanonicalPath, data: FileMetadata): void;
+}
+export interface ReadonlyFileSystemChanges<T = FileMetadata> {
+  readonly addedDirectories: Iterable<CanonicalPath>;
+  readonly removedDirectories: Iterable<CanonicalPath>;
+  readonly addedFiles: Iterable<Readonly<[CanonicalPath, T]>>;
+  readonly modifiedFiles: Iterable<Readonly<[CanonicalPath, T]>>;
+  readonly removedFiles: Iterable<Readonly<[CanonicalPath, T]>>;
+}
 export interface MutableFileSystem extends FileSystem {
-  remove(filePath: Path): null | undefined | FileMetadata;
-  addOrModify(filePath: Path, fileMetadata: FileMetadata): void;
-  bulkAddOrModify(addedOrModifiedFiles: FileData): void;
+  remove(filePath: Path, listener?: FileSystemListener): void;
+  addOrModify(
+    filePath: Path,
+    fileMetadata: FileMetadata,
+    listener?: FileSystemListener,
+  ): void;
+  bulkAddOrModify(
+    addedOrModifiedFiles: FileData,
+    listener?: FileSystemListener,
+  ): void;
 }
 export type Path = string;
 export type ProcessFileFunction = (
@@ -378,6 +428,12 @@ export type WatcherBackendChangeEvent =
       relativePath: string;
       root: string;
       metadata?: void;
+    }>
+  | Readonly<{
+      event: 'recrawl';
+      clock?: ChangeEventClock;
+      relativePath: string;
+      root: string;
     }>;
 export type WatcherBackendOptions = Readonly<{
   ignored: null | undefined | RegExp;

package/src/flow-types.js.flow

@@ -21,7 +21,7 @@ export type BuildParameters = Readonly<{
   extensions: ReadonlyArray<string>,
   forceNodeFilesystemAPI: boolean,
   ignorePattern: RegExp,
-  plugins: ReadonlyArray<FileMapPlugin<>>,
+  plugins: ReadonlyArray<InputFileMapPlugin>,
   retainAllFiles: boolean,
   rootDir: string,
   roots: ReadonlyArray<string>,
@@ -90,10 +90,16 @@ export type CacheManagerWriteOptions = Readonly<{
 //  - Real (no symlinks in path, though the path itself may be a symlink)
 export type CanonicalPath = string;
 
-export type ChangeEvent = {
+export type ChangedFileMetadata = Readonly<{
+  isSymlink: boolean,
+  modifiedTime?: ?number,
+}>;
+
+export type ChangeEvent = Readonly<{
   logger: ?RootPerfLogger,
-  eventsQueue: EventsQueue,
-};
+  changes: ReadonlyFileSystemChanges<Readonly<ChangedFileMetadata>>,
+  rootDir: string,
+}>;
 
 export type ChangeEventMetadata = {
   modifiedTime: ?number, // Epoch ms
@@ -119,8 +125,22 @@ export type CrawlerOptions = {
   rootDir: string,
   roots: ReadonlyArray<string>,
   onStatus: (status: WatcherStatus) => void,
+  // Only consider files under this normalized subdirectory when computing
+  // removedFiles. If not provided, all files in the file system are considered.
+  subpath?: string,
 };
 
+export type CrawlResult =
+  | {
+      changedFiles: FileData,
+      removedFiles: Set<Path>,
+      clocks: WatchmanClocks,
+    }
+  | {
+      changedFiles: FileData,
+      removedFiles: Set<Path>,
+    };
+
 export type DependencyExtractor = {
   extract: (
     content: string,
@@ -150,20 +170,9 @@ export type WatcherStatus =
 export type DuplicatesSet = Map<string, /* type */ number>;
 export type DuplicatesIndex = Map<string, Map<string, DuplicatesSet>>;
 
-export type EventsQueue = Array<{
-  filePath: Path,
-  metadata: ChangeEventMetadata,
-  type: string,
-}>;
-
-export type FileMapDelta<T = null | void> = Readonly<{
-  removed: Iterable<[CanonicalPath, T]>,
-  addedOrModified: Iterable<[CanonicalPath, T]>,
-}>;
-
 export type FileMapPluginInitOptions<
-  SerializableState,
-  PerFileData = void,
+  +SerializableState,
+  +PerFileData = void,
 > = Readonly<{
   files: Readonly<{
     fileIterator(
@@ -174,13 +183,13 @@ export type FileMapPluginInitOptions<
     ): Iterable<{
       baseName: string,
       canonicalPath: string,
-      pluginData: ?PerFileData,
+      +pluginData: ?PerFileData,
     }>,
     lookup(
       mixedPath: string,
     ):
       | {exists: false}
-      | {exists: true, type: 'f', pluginData: PerFileData}
+      | {exists: true, type: 'f', +pluginData: PerFileData}
       | {exists: true, type: 'd'},
   }>,
   pluginState: ?SerializableState,
@@ -205,22 +214,22 @@ export type V8Serializable =
   | Readonly<{[key: string]: V8Serializable}>;
 
 export interface FileMapPlugin<
-  SerializableState: void | V8Serializable = void | V8Serializable,
-  PerFileData: void | V8Serializable = void | V8Serializable,
+  -SerializableState extends void | V8Serializable = void | V8Serializable,
+  -PerFileData extends void | V8Serializable = void | V8Serializable,
 > {
   +name: string;
   initialize(
     initOptions: FileMapPluginInitOptions<SerializableState, PerFileData>,
   ): Promise<void>;
   assertValid(): void;
-  bulkUpdate(delta: FileMapDelta<?PerFileData>): void;
-  getSerializableSnapshot(): SerializableState;
-  onRemovedFile(relativeFilePath: string, pluginData: ?PerFileData): void;
-  onNewOrModifiedFile(relativeFilePath: string, pluginData: ?PerFileData): void;
+  onChanged(changes: ReadonlyFileSystemChanges<?PerFileData>): void;
+  getSerializableSnapshot(): void | V8Serializable;
   getCacheKey(): string;
   getWorker(): ?FileMapPluginWorker;
 }
 
+export type InputFileMapPlugin = FileMapPlugin<empty, empty>;
+
 export interface MetadataWorker {
   processFile(
     WorkerMessage,
@@ -268,7 +277,23 @@ export type FileStats = Readonly<{
 export interface FileSystem {
   exists(file: Path): boolean;
   getAllFiles(): Array<Path>;
-  getDifference(files: FileData): {
+
+  /**
+   * Given a map of files, determine which of them are new or modified
+   * (changedFiles), and which of them are missing from the input
+   * (removedFiles), vs the current state of this instance of FileSystem.
+   */
+  getDifference(
+    files: FileData,
+    options?: Readonly<{
+      /**
+       * Only consider files under this subpath (which should be a directory)
+       * when computing removedFiles. If not provided, all files in the file
+       * system are considered.
+       */
+      subpath?: string,
+    }>,
+  ): {
     changedFiles: FileData,
     removedFiles: Set<string>,
   };
@@ -423,10 +448,39 @@ export type HasteMapItem = {
 };
 export type HasteMapItemMetadata = [/* path */ string, /* type */ number];
 
+export interface FileSystemListener {
+  directoryAdded(canonicalPath: CanonicalPath): void;
+  directoryRemoved(canonicalPath: CanonicalPath): void;
+
+  fileAdded(canonicalPath: CanonicalPath, data: FileMetadata): void;
+  fileModified(
+    canonicalPath: CanonicalPath,
+    oldData: FileMetadata,
+    newData: FileMetadata,
+  ): void;
+  fileRemoved(canonicalPath: CanonicalPath, data: FileMetadata): void;
+}
+
+export interface ReadonlyFileSystemChanges<+T = FileMetadata> {
+  +addedDirectories: Iterable<CanonicalPath>;
+  +removedDirectories: Iterable<CanonicalPath>;
+
+  +addedFiles: Iterable<Readonly<[CanonicalPath, T]>>;
+  +modifiedFiles: Iterable<Readonly<[CanonicalPath, T]>>;
+  +removedFiles: Iterable<Readonly<[CanonicalPath, T]>>;
+}
+
 export interface MutableFileSystem extends FileSystem {
-  remove(filePath: Path): ?FileMetadata;
-  addOrModify(filePath: Path, fileMetadata: FileMetadata): void;
-  bulkAddOrModify(addedOrModifiedFiles: FileData): void;
+  remove(filePath: Path, listener?: FileSystemListener): void;
+  addOrModify(
+    filePath: Path,
+    fileMetadata: FileMetadata,
+    listener?: FileSystemListener,
+  ): void;
+  bulkAddOrModify(
+    addedOrModifiedFiles: FileData,
+    listener?: FileSystemListener,
+  ): void;
 }
 
 export type Path = string;
@@ -482,6 +536,12 @@ export type WatcherBackendChangeEvent =
       relativePath: string,
       root: string,
       metadata?: void,
+    }>
+  | Readonly<{
+      event: 'recrawl',
+      clock?: ChangeEventClock,
+      relativePath: string,
+      root: string,
     }>;
 
 export type WatcherBackendOptions = Readonly<{

package/src/index.d.ts

@@ -4,8 +4,15 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @format
+ * @noformat
  * @oncall react_native
+ * @generated SignedSource<<806d228988308075b7a911c3dfb513d3>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/index.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
  */
 
 import type {
@@ -16,11 +23,11 @@ import type {
   ChangeEventMetadata,
   Console,
   FileData,
-  FileMapPlugin,
   FileSystem,
   HasteMapData,
   HasteMapItem,
   HType,
+  InputFileMapPlugin,
   PerfLoggerFactory,
 } from './flow-types';
 
@@ -36,6 +43,7 @@ export type {
   FileSystem,
   HasteMapData,
   HasteMapItem,
+  InputFileMapPlugin,
 };
 export type InputOptions = Readonly<{
   computeSha1?: null | undefined | boolean;
@@ -43,7 +51,7 @@ export type InputOptions = Readonly<{
   extensions: ReadonlyArray<string>;
   forceNodeFilesystemAPI?: null | undefined | boolean;
   ignorePattern?: null | undefined | RegExp;
-  plugins?: ReadonlyArray<AnyFileMapPlugin>;
+  plugins?: ReadonlyArray<InputFileMapPlugin>;
   retainAllFiles: boolean;
   rootDir: string;
   roots: ReadonlyArray<string>;
@@ -64,7 +72,6 @@ type HealthCheckOptions = Readonly<{
   timeout: number;
   filePrefix: string;
 }>;
-type AnyFileMapPlugin = FileMapPlugin<any, any>;
 export {DiskCacheManager} from './cache/DiskCacheManager';
 export {default as DependencyPlugin} from './plugins/DependencyPlugin';
 export type {DependencyPluginOptions} from './plugins/DependencyPlugin';