@powerlines/core 0.15.0 → 0.15.1

package/dist/lib/vfs.d.cts

@@ -0,0 +1,321 @@
+import { ResolveOptions, VirtualFileMetadata, VirtualFileSystemInterface, WriteOptions } from "../types/fs.cjs";
+import { Context } from "../types/context.cjs";
+import { AssetGlob } from "@stryke/types/file";
+import { FlatCache } from "flat-cache";
+
+//#region src/lib/vfs.d.ts
+/**
+ * Represents a virtual file system (VFS) that stores files and their associated metadata in virtual memory.
+ *
+ * @remarks
+ * This class provides methods to manage virtual files, check their existence, retrieve their content, and manipulate the virtual file system. It allows for efficient file management and retrieval without relying on the actual file system.
+ */
+declare class VirtualFileSystem implements VirtualFileSystemInterface {
+  #private;
+  /**
+   * Creates a virtual file system (VFS) that is backed up to a Cap'n Proto message buffer.
+   *
+   * @param context - The context of the virtual file system, typically containing options and logging functions.
+   * @returns A promise that resolves to a new virtual file system instance.
+   */
+  static create(context: Context): Promise<VirtualFileSystem>;
+  /**
+   * Synchronously creates a virtual file system (VFS) that is backed up to a Cap'n Proto message buffer.
+   *
+   * @param context - The context of the virtual file system, typically containing options and logging functions.
+   * @returns A new virtual file system instance.
+   */
+  static createSync(context: Context): VirtualFileSystem;
+  /**
+   * A map of file ids to their metadata.
+   */
+  get metadata(): Record<string, VirtualFileMetadata>;
+  /**
+   * A map of file paths to their module ids.
+   */
+  get ids(): Record<string, string>;
+  /**
+   * A map of module ids to their file paths.
+   */
+  get paths(): Record<string, string>;
+  /**
+   * Gets the resolver cache.
+   */
+  protected get resolverCache(): FlatCache;
+  /**
+   * Creates a new instance of the {@link VirtualFileSystem}.
+   *
+   * @param context - The context of the virtual file system, typically containing options and logging functions.
+   * @param fs - A buffer containing the serialized virtual file system data.
+   */
+  private constructor();
+  /**
+   * Asynchronously checks if a file exists in the virtual file system (VFS).
+   *
+   * @param path - The path to the file.
+   * @returns A promise that resolves to `true` if the file exists, otherwise `false`.
+   */
+  exists(path: string): Promise<boolean>;
+  /**
+   * Synchronously checks if a file exists in the virtual file system (VFS).
+   *
+   * @param path - The path to the file.
+   * @returns `true` if the file exists, otherwise `false`.
+   */
+  existsSync(path: string): boolean;
+  /**
+   * Checks if a file is virtual in the virtual file system (VFS).
+   *
+   * @param path - The path to the file.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns `true` if the file is virtual, otherwise `false`.
+   */
+  isVirtual(path: string, importer?: string | undefined, options?: ResolveOptions): boolean;
+  /**
+   * Checks if a path is a directory in the virtual file system (VFS).
+   *
+   * @param path - The path to check.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns `true` if the path is a directory, otherwise `false`.
+   */
+  isDirectorySync(path: string, importer?: string | undefined, options?: ResolveOptions): boolean;
+  /**
+   * Checks if a path is a directory in the virtual file system (VFS).
+   *
+   * @param path - The path to check.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns `true` if the path is a directory, otherwise `false`.
+   */
+  isDirectory(path: string, importer?: string | undefined, options?: ResolveOptions): Promise<boolean>;
+  /**
+   * Checks if a path is a file in the virtual file system (VFS).
+   *
+   * @param path - The path to check.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns `true` if the path is a file, otherwise `false`.
+   */
+  isFileSync(path: string, importer?: string | undefined, options?: ResolveOptions): boolean;
+  /**
+   * Checks if a path is a file in the virtual file system (VFS).
+   *
+   * @param path - The path to check.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns `true` if the path is a file, otherwise `false`.
+   */
+  isFile(path: string, importer?: string | undefined, options?: ResolveOptions): Promise<boolean>;
+  /**
+   * Checks if a file Id must be resolved by the virtual file system (VFS).
+   *
+   * @remarks
+   * Examples of file Ids that would be considered virtual include:
+   * - Ids that start with the framework specific prefix (e.g. `powerlines:`)
+   * - Ids that match a configured alias for virtual modules (returned true from {@link VirtualFileSystemInterface.isVirtual})
+   *
+   * @param path - The path or id of the file.
+   * @param importer - An optional path to the importer module, used for resolving the file path.
+   * @param options - Additional options for resolving the file path.
+   * @returns `true` if the file is virtual, otherwise `false`.
+   */
+  isResolvableId(path: string, importer?: string | undefined, options?: ResolveOptions): boolean;
+  /**
+   * Lists files in a given path.
+   *
+   * @param path - The path to list files from.
+   * @returns An array of file names in the specified path.
+   */
+  listSync(path: string): string[];
+  /**
+   * Lists files in a given path.
+   *
+   * @param path - The path to list files from.
+   * @returns An array of file names in the specified path.
+   */
+  list(path: string): Promise<string[]>;
+  /**
+   * Removes a file in the virtual file system (VFS).
+   *
+   * @param path - The path to create the directory at.
+   */
+  remove(path: string): Promise<void>;
+  /**
+   * Removes a file in the virtual file system (VFS).
+   *
+   * @param path - The path to create the directory at.
+   */
+  removeSync(path: string): void;
+  /**
+   * Glob files in the virtual file system (VFS) based on the provided pattern(s).
+   *
+   * @param patterns - A pattern (or multiple patterns) to use to determine the file paths to return
+   * @returns An array of file paths matching the provided pattern(s)
+   */
+  glob(patterns: string | Omit<AssetGlob, "output"> | (string | Omit<AssetGlob, "output">)[]): Promise<string[]>;
+  /**
+   * Synchronously glob files in the virtual file system (VFS) based on the provided pattern(s).
+   *
+   * @param patterns - A pattern (or multiple patterns) to use to determine the file paths to return
+   * @returns An array of file paths matching the provided pattern(s)
+   */
+  globSync(patterns: string | Omit<AssetGlob, "output"> | (string | Omit<AssetGlob, "output">)[]): string[];
+  /**
+   * Copies a file from one path to another in the virtual file system (VFS).
+   *
+   * @param srcPath - The source path to copy
+   * @param destPath - The destination path to copy to
+   */
+  copy(srcPath: string | URL | Omit<AssetGlob, "output">, destPath: string | URL): Promise<void>;
+  /**
+   * Synchronously copies a file from one path to another in the virtual file system (VFS).
+   *
+   * @param srcPath - The source path to copy
+   * @param destPath - The destination path to copy to
+   */
+  copySync(srcPath: string | URL | Omit<AssetGlob, "output">, destPath: string | URL): void;
+  /**
+   * Moves a file (or files) from one path to another in the virtual file system (VFS).
+   *
+   * @param srcPath - The source path to move
+   * @param destPath - The destination path to move to
+   */
+  move(srcPath: string, destPath: string): Promise<void>;
+  /**
+   * Synchronously moves a file (or files) from one path to another in the virtual file system (VFS).
+   *
+   * @param srcPath - The source path to move
+   * @param destPath - The destination path to move to
+   */
+  moveSync(srcPath: string, destPath: string): void;
+  /**
+   * Asynchronously reads a file from the virtual file system (VFS).
+   *
+   * @param path - The path or ID of the file to read.
+   * @returns A promise that resolves to the contents of the file as a string, or undefined if the file does not exist.
+   */
+  read(path: string): Promise<string | undefined>;
+  /**
+   * Synchronously reads a file from the virtual file system (VFS).
+   *
+   * @param path - The path or ID of the file to read.
+   * @returns The contents of the file as a string, or undefined if the file does not exist.
+   */
+  readSync(path: string): string | undefined;
+  /**
+   * Writes a file to the virtual file system (VFS).
+   *
+   * @param path - The path to the file.
+   * @param data - The contents of the file.
+   * @param options - Optional parameters for writing the file.
+   * @returns A promise that resolves when the file is written.
+   */
+  write(path: string, data?: string, options?: WriteOptions): Promise<void>;
+  /**
+   * Synchronously writes a file to the virtual file system (VFS).
+   *
+   * @param path - The file to write.
+   * @param data - The contents of the file.
+   * @param options - Optional parameters for writing the file.
+   */
+  writeSync(path: string, data?: string, options?: WriteOptions): void;
+  /**
+   * Synchronously creates a directory at the specified path.
+   *
+   * @param dirPath - The path of the directory to create.
+   */
+  mkdirSync(dirPath: string): void;
+  /**
+   * Creates a directory at the specified path.
+   *
+   * @param path - The path of the directory to create.
+   */
+  mkdir(path: string): Promise<void>;
+  /**
+   * Retrieves the metadata of a file in the virtual file system (VFS).
+   *
+   * @param pathOrId - The path or ID of the file to retrieve metadata for.
+   * @returns The metadata of the file, or undefined if the file does not exist.
+   */
+  getMetadata(pathOrId: string): VirtualFileMetadata | undefined;
+  /**
+   * Resolves a given module ID using the configured aliases.
+   *
+   * @remarks
+   * This function can be used to map module IDs to different paths based on the alias configuration.
+   *
+   * @param id - The module ID to resolve.
+   * @returns The resolved module ID - after applying any configured aliases (this will be the same as the input ID if no aliases match).
+   */
+  resolveAlias(id: string): string;
+  /**
+   * Checks if a given module ID is an alias.
+   *
+   * @remarks
+   * This function can be used to determine if a module ID matches any configured aliases.
+   *
+   * @param id - The module ID to check.
+   * @returns A boolean indicating whether the module ID is an alias.
+   */
+  isAlias(id: string): boolean;
+  /**
+   * Checks if a given module ID is a tsconfig path.
+   *
+   * @remarks
+   * This function can be used to determine if a module ID matches any configured tsconfig paths.
+   *
+   * @param id - The module ID to check.
+   * @returns A boolean indicating whether the module ID is a tsconfig path.
+   */
+  isTsconfigPath(id: string): boolean;
+  /**
+   * A helper function to resolve modules in the virtual file system (VFS).
+   *
+   * @remarks
+   * This function can be used to resolve modules relative to the project root directory.
+   *
+   * @example
+   * ```ts
+   * const resolved = await context.resolvePath("some-module", "/path/to/importer");
+   * ```
+   *
+   * @param id - The module to resolve.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns A promise that resolves to the resolved module path.
+   */
+  resolve(id: string, importer?: string, options?: ResolveOptions): Promise<string | undefined>;
+  /**
+   * A synchronous helper function to resolve modules using the Jiti resolver
+   *
+   * @remarks
+   * This function can be used to resolve modules relative to the project root directory.
+   *
+   * @example
+   * ```ts
+   * const resolvedPath = context.resolveSync("some-module", "/path/to/importer");
+   * ```
+   *
+   * @param id - The module to resolve.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns The resolved module path.
+   */
+  resolveSync(id: string, importer?: string, options?: ResolveOptions): string | undefined;
+  /**
+   * Disposes of the virtual file system (VFS) by saving its state to disk.
+   */
+  dispose(): Promise<void>;
+  /**
+   * Asynchronously disposes of the virtual file system (VFS) by saving its state to disk.
+   *
+   * @remarks
+   * This method is automatically called when the VFS instance is used within a `using` block, or can be manually invoked to ensure that the VFS state is saved and resources are cleaned up properly.
+   */
+  [Symbol.asyncDispose](): Promise<void>;
+}
+//#endregion
+export { VirtualFileSystem };
+//# sourceMappingURL=vfs.d.cts.map

package/dist/lib/vfs.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vfs.d.cts","names":[],"sources":["../../src/lib/vfs.ts"],"mappings":";;;;;;;;AA4LA;;;;cAAa,iBAAA,YAA6B,0BAAA;EAAA;EAsgBN;;;;;;EAAA,OA1Ed,MAAA,CAAO,OAAA,EAAS,OAAA,GAAU,OAAA,CAAQ,iBAAA;EAkZnB;;;;;;EAAA,OAxUrB,UAAA,CAAW,OAAA,EAAS,OAAA,GAAU,iBAAA;EAodzC;;;EAAA,IAjZQ,QAAA,CAAA,GAAY,MAAA,SAAe,mBAAA;EAujB3B;;;EAAA,IA5hBA,GAAA,CAAA,GAAO,MAAA;EA8hBf;;;EAAA,IAngBQ,KAAA,CAAA,GAAS,MAAA;EAojBJ;;;EAAA,cAvhBF,aAAA,CAAA,GAAiB,SAAA;EAukBV;;;;;;EAAA,QAxgBd,WAAA,CAAA;EA0pB0B;;;;;;EAviBpB,MAAA,CAAO,IAAA,WAAe,OAAA;EA62BhC;;;;;;EAj2BI,UAAA,CAAW,IAAA;EA11BgD;;;;;;;;EAw2B3D,SAAA,CACL,IAAA,UACA,QAAA,uBACA,OAAA,GAAU,cAAA;EArWsB;;;;;;;;EAkY3B,eAAA,CACL,IAAA,UACA,QAAA,uBACA,OAAA,GAAU,cAAA;EA5QQ;;;;;;;;EAoSP,WAAA,CACX,IAAA,UACA,QAAA,uBACA,OAAA,GAAU,cAAA,GACT,OAAA;EA/DI;;;;;;;;EAsFA,UAAA,CACL,IAAA,UACA,QAAA,uBACA,OAAA,GAAU,cAAA;EAtDV;;;;;;;;EA2EW,MAAA,CACX,IAAA,UACA,QAAA,uBACA,OAAA,GAAU,cAAA,GACT,OAAA;EA1BD;;;;;;;;;;;;;EAqDK,cAAA,CACL,IAAA,UACA,QAAA,uBACA,OAAA,GAAU,cAAA;EAkBL;;;;;;EAAA,QAAA,CAAS,IAAA;EAgEmB;;;;;;EAjCtB,IAAA,CAAK,IAAA,WAAe,OAAA;EAwFZ;;;;;EAvDR,MAAA,CAAO,IAAA,WAAe,OAAA;EAyGnB;;;;;EAhFT,UAAA,CAAW,IAAA;EA+Ha;;;;;;EArGlB,IAAA,CACX,QAAA,WAEI,IAAA,CAAK,SAAA,wBACK,IAAA,CAAK,SAAA,iBAClB,OAAA;EAqJuB;;;;;;EAxGnB,QAAA,CACL,QAAA,WAEI,IAAA,CAAK,SAAA,wBACK,IAAA,CAAK,SAAA;EA4Jc;;;;;;EA9GtB,IAAA,CACX,OAAA,WAAkB,GAAA,GAAM,IAAA,CAAK,SAAA,aAC7B,QAAA,WAAmB,GAAA,GAAG,OAAA;EAkJS;;;;;;EA/F1B,QAAA,CACL,OAAA,WAAkB,GAAA,GAAM,IAAA,CAAK,SAAA,aAC7B,QAAA,WAAmB,GAAA;EAsInB;;;;;;EA/EW,IAAA,CAAK,OAAA,UAAiB,QAAA,WAAgB,OAAA;EAgM5C;;;;;;EA5KA,QAAA,CAAS,OAAA,UAAiB,QAAA;EA+LK;;;;;;EA7KzB,IAAA,CAAK,IAAA,WAAe,OAAA;EAkUpB;;;;;;EAhTN,QAAA,CAAS,IAAA;EAoWd;;;;;;;;EAhVW,KAAA,CACX,IAAA,UACA,IAAA,WACA,OAAA,GAAS,YAAA,GACR,OAAA;EA6b+B;;;;;;;EAtX3B,SAAA,CACL,IAAA,UACA,IAAA,WACA,OAAA,GAAS,YAAA;;;;;;EAsCJ,SAAA,CAAU,OAAA;;;;;;EASJ,KAAA,CAAM,IAAA,WAAe,OAAA;;;;;;;EAU3B,WAAA,CAAY,QAAA,WAAmB,mBAAA;;;;;;;;;;EAkB/B,YAAA,CAAa,EAAA;;;;;;;;;;EAsEb,OAAA,CAAQ,EAAA;;;;;;;;;;EAqCR,cAAA,CAAe,EAAA;;;;;;;;;;;;;;;;;EAwBT,OAAA,CACX,EAAA,UACA,QAAA,WACA,OAAA,GAAS,cAAA,GACR,OAAA;;;;;;;;;;;;;;;;;EA+CI,WAAA,CACL,EAAA,UACA,QAAA,WACA,OAAA,GAAS,cAAA;;;;EAmCE,OAAA,CAAA,GAAO,OAAA;;;;;;;GA4EN,MAAA,CAAO,YAAA,KAAa,OAAA;AAAA"}

package/dist/lib/vfs.d.mts

@@ -0,0 +1,321 @@
+import { ResolveOptions, VirtualFileMetadata, VirtualFileSystemInterface, WriteOptions } from "../types/fs.mjs";
+import { Context } from "../types/context.mjs";
+import { FlatCache } from "flat-cache";
+import { AssetGlob } from "@stryke/types/file";
+
+//#region src/lib/vfs.d.ts
+/**
+ * Represents a virtual file system (VFS) that stores files and their associated metadata in virtual memory.
+ *
+ * @remarks
+ * This class provides methods to manage virtual files, check their existence, retrieve their content, and manipulate the virtual file system. It allows for efficient file management and retrieval without relying on the actual file system.
+ */
+declare class VirtualFileSystem implements VirtualFileSystemInterface {
+  #private;
+  /**
+   * Creates a virtual file system (VFS) that is backed up to a Cap'n Proto message buffer.
+   *
+   * @param context - The context of the virtual file system, typically containing options and logging functions.
+   * @returns A promise that resolves to a new virtual file system instance.
+   */
+  static create(context: Context): Promise<VirtualFileSystem>;
+  /**
+   * Synchronously creates a virtual file system (VFS) that is backed up to a Cap'n Proto message buffer.
+   *
+   * @param context - The context of the virtual file system, typically containing options and logging functions.
+   * @returns A new virtual file system instance.
+   */
+  static createSync(context: Context): VirtualFileSystem;
+  /**
+   * A map of file ids to their metadata.
+   */
+  get metadata(): Record<string, VirtualFileMetadata>;
+  /**
+   * A map of file paths to their module ids.
+   */
+  get ids(): Record<string, string>;
+  /**
+   * A map of module ids to their file paths.
+   */
+  get paths(): Record<string, string>;
+  /**
+   * Gets the resolver cache.
+   */
+  protected get resolverCache(): FlatCache;
+  /**
+   * Creates a new instance of the {@link VirtualFileSystem}.
+   *
+   * @param context - The context of the virtual file system, typically containing options and logging functions.
+   * @param fs - A buffer containing the serialized virtual file system data.
+   */
+  private constructor();
+  /**
+   * Asynchronously checks if a file exists in the virtual file system (VFS).
+   *
+   * @param path - The path to the file.
+   * @returns A promise that resolves to `true` if the file exists, otherwise `false`.
+   */
+  exists(path: string): Promise<boolean>;
+  /**
+   * Synchronously checks if a file exists in the virtual file system (VFS).
+   *
+   * @param path - The path to the file.
+   * @returns `true` if the file exists, otherwise `false`.
+   */
+  existsSync(path: string): boolean;
+  /**
+   * Checks if a file is virtual in the virtual file system (VFS).
+   *
+   * @param path - The path to the file.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns `true` if the file is virtual, otherwise `false`.
+   */
+  isVirtual(path: string, importer?: string | undefined, options?: ResolveOptions): boolean;
+  /**
+   * Checks if a path is a directory in the virtual file system (VFS).
+   *
+   * @param path - The path to check.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns `true` if the path is a directory, otherwise `false`.
+   */
+  isDirectorySync(path: string, importer?: string | undefined, options?: ResolveOptions): boolean;
+  /**
+   * Checks if a path is a directory in the virtual file system (VFS).
+   *
+   * @param path - The path to check.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns `true` if the path is a directory, otherwise `false`.
+   */
+  isDirectory(path: string, importer?: string | undefined, options?: ResolveOptions): Promise<boolean>;
+  /**
+   * Checks if a path is a file in the virtual file system (VFS).
+   *
+   * @param path - The path to check.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns `true` if the path is a file, otherwise `false`.
+   */
+  isFileSync(path: string, importer?: string | undefined, options?: ResolveOptions): boolean;
+  /**
+   * Checks if a path is a file in the virtual file system (VFS).
+   *
+   * @param path - The path to check.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns `true` if the path is a file, otherwise `false`.
+   */
+  isFile(path: string, importer?: string | undefined, options?: ResolveOptions): Promise<boolean>;
+  /**
+   * Checks if a file Id must be resolved by the virtual file system (VFS).
+   *
+   * @remarks
+   * Examples of file Ids that would be considered virtual include:
+   * - Ids that start with the framework specific prefix (e.g. `powerlines:`)
+   * - Ids that match a configured alias for virtual modules (returned true from {@link VirtualFileSystemInterface.isVirtual})
+   *
+   * @param path - The path or id of the file.
+   * @param importer - An optional path to the importer module, used for resolving the file path.
+   * @param options - Additional options for resolving the file path.
+   * @returns `true` if the file is virtual, otherwise `false`.
+   */
+  isResolvableId(path: string, importer?: string | undefined, options?: ResolveOptions): boolean;
+  /**
+   * Lists files in a given path.
+   *
+   * @param path - The path to list files from.
+   * @returns An array of file names in the specified path.
+   */
+  listSync(path: string): string[];
+  /**
+   * Lists files in a given path.
+   *
+   * @param path - The path to list files from.
+   * @returns An array of file names in the specified path.
+   */
+  list(path: string): Promise<string[]>;
+  /**
+   * Removes a file in the virtual file system (VFS).
+   *
+   * @param path - The path to create the directory at.
+   */
+  remove(path: string): Promise<void>;
+  /**
+   * Removes a file in the virtual file system (VFS).
+   *
+   * @param path - The path to create the directory at.
+   */
+  removeSync(path: string): void;
+  /**
+   * Glob files in the virtual file system (VFS) based on the provided pattern(s).
+   *
+   * @param patterns - A pattern (or multiple patterns) to use to determine the file paths to return
+   * @returns An array of file paths matching the provided pattern(s)
+   */
+  glob(patterns: string | Omit<AssetGlob, "output"> | (string | Omit<AssetGlob, "output">)[]): Promise<string[]>;
+  /**
+   * Synchronously glob files in the virtual file system (VFS) based on the provided pattern(s).
+   *
+   * @param patterns - A pattern (or multiple patterns) to use to determine the file paths to return
+   * @returns An array of file paths matching the provided pattern(s)
+   */
+  globSync(patterns: string | Omit<AssetGlob, "output"> | (string | Omit<AssetGlob, "output">)[]): string[];
+  /**
+   * Copies a file from one path to another in the virtual file system (VFS).
+   *
+   * @param srcPath - The source path to copy
+   * @param destPath - The destination path to copy to
+   */
+  copy(srcPath: string | URL | Omit<AssetGlob, "output">, destPath: string | URL): Promise<void>;
+  /**
+   * Synchronously copies a file from one path to another in the virtual file system (VFS).
+   *
+   * @param srcPath - The source path to copy
+   * @param destPath - The destination path to copy to
+   */
+  copySync(srcPath: string | URL | Omit<AssetGlob, "output">, destPath: string | URL): void;
+  /**
+   * Moves a file (or files) from one path to another in the virtual file system (VFS).
+   *
+   * @param srcPath - The source path to move
+   * @param destPath - The destination path to move to
+   */
+  move(srcPath: string, destPath: string): Promise<void>;
+  /**
+   * Synchronously moves a file (or files) from one path to another in the virtual file system (VFS).
+   *
+   * @param srcPath - The source path to move
+   * @param destPath - The destination path to move to
+   */
+  moveSync(srcPath: string, destPath: string): void;
+  /**
+   * Asynchronously reads a file from the virtual file system (VFS).
+   *
+   * @param path - The path or ID of the file to read.
+   * @returns A promise that resolves to the contents of the file as a string, or undefined if the file does not exist.
+   */
+  read(path: string): Promise<string | undefined>;
+  /**
+   * Synchronously reads a file from the virtual file system (VFS).
+   *
+   * @param path - The path or ID of the file to read.
+   * @returns The contents of the file as a string, or undefined if the file does not exist.
+   */
+  readSync(path: string): string | undefined;
+  /**
+   * Writes a file to the virtual file system (VFS).
+   *
+   * @param path - The path to the file.
+   * @param data - The contents of the file.
+   * @param options - Optional parameters for writing the file.
+   * @returns A promise that resolves when the file is written.
+   */
+  write(path: string, data?: string, options?: WriteOptions): Promise<void>;
+  /**
+   * Synchronously writes a file to the virtual file system (VFS).
+   *
+   * @param path - The file to write.
+   * @param data - The contents of the file.
+   * @param options - Optional parameters for writing the file.
+   */
+  writeSync(path: string, data?: string, options?: WriteOptions): void;
+  /**
+   * Synchronously creates a directory at the specified path.
+   *
+   * @param dirPath - The path of the directory to create.
+   */
+  mkdirSync(dirPath: string): void;
+  /**
+   * Creates a directory at the specified path.
+   *
+   * @param path - The path of the directory to create.
+   */
+  mkdir(path: string): Promise<void>;
+  /**
+   * Retrieves the metadata of a file in the virtual file system (VFS).
+   *
+   * @param pathOrId - The path or ID of the file to retrieve metadata for.
+   * @returns The metadata of the file, or undefined if the file does not exist.
+   */
+  getMetadata(pathOrId: string): VirtualFileMetadata | undefined;
+  /**
+   * Resolves a given module ID using the configured aliases.
+   *
+   * @remarks
+   * This function can be used to map module IDs to different paths based on the alias configuration.
+   *
+   * @param id - The module ID to resolve.
+   * @returns The resolved module ID - after applying any configured aliases (this will be the same as the input ID if no aliases match).
+   */
+  resolveAlias(id: string): string;
+  /**
+   * Checks if a given module ID is an alias.
+   *
+   * @remarks
+   * This function can be used to determine if a module ID matches any configured aliases.
+   *
+   * @param id - The module ID to check.
+   * @returns A boolean indicating whether the module ID is an alias.
+   */
+  isAlias(id: string): boolean;
+  /**
+   * Checks if a given module ID is a tsconfig path.
+   *
+   * @remarks
+   * This function can be used to determine if a module ID matches any configured tsconfig paths.
+   *
+   * @param id - The module ID to check.
+   * @returns A boolean indicating whether the module ID is a tsconfig path.
+   */
+  isTsconfigPath(id: string): boolean;
+  /**
+   * A helper function to resolve modules in the virtual file system (VFS).
+   *
+   * @remarks
+   * This function can be used to resolve modules relative to the project root directory.
+   *
+   * @example
+   * ```ts
+   * const resolved = await context.resolvePath("some-module", "/path/to/importer");
+   * ```
+   *
+   * @param id - The module to resolve.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns A promise that resolves to the resolved module path.
+   */
+  resolve(id: string, importer?: string, options?: ResolveOptions): Promise<string | undefined>;
+  /**
+   * A synchronous helper function to resolve modules using the Jiti resolver
+   *
+   * @remarks
+   * This function can be used to resolve modules relative to the project root directory.
+   *
+   * @example
+   * ```ts
+   * const resolvedPath = context.resolveSync("some-module", "/path/to/importer");
+   * ```
+   *
+   * @param id - The module to resolve.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns The resolved module path.
+   */
+  resolveSync(id: string, importer?: string, options?: ResolveOptions): string | undefined;
+  /**
+   * Disposes of the virtual file system (VFS) by saving its state to disk.
+   */
+  dispose(): Promise<void>;
+  /**
+   * Asynchronously disposes of the virtual file system (VFS) by saving its state to disk.
+   *
+   * @remarks
+   * This method is automatically called when the VFS instance is used within a `using` block, or can be manually invoked to ensure that the VFS state is saved and resources are cleaned up properly.
+   */
+  [Symbol.asyncDispose](): Promise<void>;
+}
+//#endregion
+export { VirtualFileSystem };
+//# sourceMappingURL=vfs.d.mts.map

package/dist/lib/vfs.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vfs.d.mts","names":[],"sources":["../../src/lib/vfs.ts"],"mappings":";;;;;;;;AA4LA;;;;cAAa,iBAAA,YAA6B,0BAAA;EAAA;EAsgBN;;;;;;EAAA,OA1Ed,MAAA,CAAO,OAAA,EAAS,OAAA,GAAU,OAAA,CAAQ,iBAAA;EAkZnB;;;;;;EAAA,OAxUrB,UAAA,CAAW,OAAA,EAAS,OAAA,GAAU,iBAAA;EAodzC;;;EAAA,IAjZQ,QAAA,CAAA,GAAY,MAAA,SAAe,mBAAA;EAujB3B;;;EAAA,IA5hBA,GAAA,CAAA,GAAO,MAAA;EA8hBf;;;EAAA,IAngBQ,KAAA,CAAA,GAAS,MAAA;EAojBJ;;;EAAA,cAvhBF,aAAA,CAAA,GAAiB,SAAA;EAukBV;;;;;;EAAA,QAxgBd,WAAA,CAAA;EA0pB0B;;;;;;EAviBpB,MAAA,CAAO,IAAA,WAAe,OAAA;EA62BhC;;;;;;EAj2BI,UAAA,CAAW,IAAA;EA11BgD;;;;;;;;EAw2B3D,SAAA,CACL,IAAA,UACA,QAAA,uBACA,OAAA,GAAU,cAAA;EArWsB;;;;;;;;EAkY3B,eAAA,CACL,IAAA,UACA,QAAA,uBACA,OAAA,GAAU,cAAA;EA5QQ;;;;;;;;EAoSP,WAAA,CACX,IAAA,UACA,QAAA,uBACA,OAAA,GAAU,cAAA,GACT,OAAA;EA/DI;;;;;;;;EAsFA,UAAA,CACL,IAAA,UACA,QAAA,uBACA,OAAA,GAAU,cAAA;EAtDV;;;;;;;;EA2EW,MAAA,CACX,IAAA,UACA,QAAA,uBACA,OAAA,GAAU,cAAA,GACT,OAAA;EA1BD;;;;;;;;;;;;;EAqDK,cAAA,CACL,IAAA,UACA,QAAA,uBACA,OAAA,GAAU,cAAA;EAkBL;;;;;;EAAA,QAAA,CAAS,IAAA;EAgEmB;;;;;;EAjCtB,IAAA,CAAK,IAAA,WAAe,OAAA;EAwFZ;;;;;EAvDR,MAAA,CAAO,IAAA,WAAe,OAAA;EAyGnB;;;;;EAhFT,UAAA,CAAW,IAAA;EA+Ha;;;;;;EArGlB,IAAA,CACX,QAAA,WAEI,IAAA,CAAK,SAAA,wBACK,IAAA,CAAK,SAAA,iBAClB,OAAA;EAqJuB;;;;;;EAxGnB,QAAA,CACL,QAAA,WAEI,IAAA,CAAK,SAAA,wBACK,IAAA,CAAK,SAAA;EA4Jc;;;;;;EA9GtB,IAAA,CACX,OAAA,WAAkB,GAAA,GAAM,IAAA,CAAK,SAAA,aAC7B,QAAA,WAAmB,GAAA,GAAG,OAAA;EAkJS;;;;;;EA/F1B,QAAA,CACL,OAAA,WAAkB,GAAA,GAAM,IAAA,CAAK,SAAA,aAC7B,QAAA,WAAmB,GAAA;EAsInB;;;;;;EA/EW,IAAA,CAAK,OAAA,UAAiB,QAAA,WAAgB,OAAA;EAgM5C;;;;;;EA5KA,QAAA,CAAS,OAAA,UAAiB,QAAA;EA+LK;;;;;;EA7KzB,IAAA,CAAK,IAAA,WAAe,OAAA;EAkUpB;;;;;;EAhTN,QAAA,CAAS,IAAA;EAoWd;;;;;;;;EAhVW,KAAA,CACX,IAAA,UACA,IAAA,WACA,OAAA,GAAS,YAAA,GACR,OAAA;EA6b+B;;;;;;;EAtX3B,SAAA,CACL,IAAA,UACA,IAAA,WACA,OAAA,GAAS,YAAA;;;;;;EAsCJ,SAAA,CAAU,OAAA;;;;;;EASJ,KAAA,CAAM,IAAA,WAAe,OAAA;;;;;;;EAU3B,WAAA,CAAY,QAAA,WAAmB,mBAAA;;;;;;;;;;EAkB/B,YAAA,CAAa,EAAA;;;;;;;;;;EAsEb,OAAA,CAAQ,EAAA;;;;;;;;;;EAqCR,cAAA,CAAe,EAAA;;;;;;;;;;;;;;;;;EAwBT,OAAA,CACX,EAAA,UACA,QAAA,WACA,OAAA,GAAS,cAAA,GACR,OAAA;;;;;;;;;;;;;;;;;EA+CI,WAAA,CACL,EAAA,UACA,QAAA,WACA,OAAA,GAAS,cAAA;;;;EAmCE,OAAA,CAAA,GAAO,OAAA;;;;;;;GA4EN,MAAA,CAAO,YAAA,KAAa,OAAA;AAAA"}