powerlines 0.10.0 → 0.10.1

package/dist/types/vfs.d.cts

@@ -1,3 +1,4 @@
+import { PrimitiveJsonValue } from '@stryke/json/types';
 import { Volume } from 'memfs';
 import { StatSyncOptions, Stats, PathLike, RmDirOptions, RmOptions, Mode, MakeDirectoryOptions as MakeDirectoryOptions$1, PathOrFileDescriptor, WriteFileOptions as WriteFileOptions$1 } from 'node:fs';
 import { IUnionFs } from 'unionfs';
@@ -9,30 +10,57 @@ declare const __VFS_CACHE__ = "__VFS_CACHE__";
 declare const __VFS_RESOLVER__ = "__VFS_RESOLVER__";
 declare const __VFS_VIRTUAL__ = "__VFS_VIRTUAL__";
 declare const __VFS_UNIFIED__ = "__VFS_UNIFIED__";
+type OutputModeType = "fs" | "virtual";
 interface VirtualFile {
     /**
-     * A virtual path to the file in the virtual file system.
+     * The unique identifier for the virtual file.
+     *
+     * @remarks
+     * If no specific id is provided, it defaults to the file's {@link path}.
      */
-    path: string;
+    id: string;
     /**
-     * The contents of the virtual file.
+     * Additional metadata associated with the virtual file.
      */
-    contents: string;
-}
-interface VirtualBuiltinFile extends VirtualFile {
+    details: Record<string, PrimitiveJsonValue>;
     /**
-     * The unique identifier for the virtual file.
+     * The variant of the file.
      *
      * @remarks
-     * This property is read-only and is set when the file is created.
+     * This string represents the purpose/function of the file in the virtual file system. A potential list of variants includes:
+     * - `builtin`: Indicates that the file is a built-in module provided by the system.
+     * - `entry`: Indicates that the file is an entry point for execution.
+     * - `normal`: Indicates that the file is a standard file without any special role.
      */
-    id: string;
+    variant: string;
+    /**
+     * The output mode of the file.
+     *
+     * @remarks
+     * This indicates whether the file is intended to be written to the actual file system (`fs`) or kept in the virtual file system (`virtual`).
+     */
+    mode: OutputModeType;
+    /**
+     * A virtual (or actual) path to the file in the file system.
+     */
+    path: string;
+    /**
+     * The contents of the file.
+     */
+    code: string | NodeJS.ArrayBufferView;
 }
-type OutputModeType = "fs" | "virtual";
+type VirtualFileSystemMetadata = Pick<VirtualFile, "id" | "details" | "variant" | "mode">;
 interface ResolveFSOptions {
     mode?: OutputModeType;
 }
 type MakeDirectoryOptions = (Mode | MakeDirectoryOptions$1) & ResolveFSOptions;
+interface PowerlinesWriteFileOptions extends ResolveFSOptions {
+    skipFormat?: boolean;
+}
+type NodeWriteFileOptions = WriteFileOptions$1;
+type WriteFileOptions = NodeWriteFileOptions | PowerlinesWriteFileOptions;
+type PowerLinesWriteFileData = Partial<Omit<VirtualFile, "path" | "mode" | "code">> & Pick<VirtualFile, "code">;
+type WriteFileData = string | NodeJS.ArrayBufferView | PowerLinesWriteFileData;
 interface ResolvePathOptions extends ResolveFSOptions {
     /**
      * Should the resolved path include the file extension?
@@ -49,82 +77,63 @@ interface ResolvePathOptions extends ResolveFSOptions {
      */
     type?: "file" | "directory";
 }
-type WriteFileOptions = WriteFileOptions$1 & ResolveFSOptions;
-interface WriteBuiltinFileOptions extends ResolveFSOptions {
-    skipFormat?: boolean;
-}
 interface VirtualFileSystemInterface {
     [__VFS_INIT__]: () => void;
     [__VFS_REVERT__]: () => void;
     /**
-     * The underlying builtin module Ids.
-     */
-    builtinIdMap: Map<string, string>;
-    /**
-     * Checks if a path or ID corresponds to a builtin file.
-     *
-     * @param id - The id of the builtin file to check against.
-     * @param pathOrId - The path or id of the file to check.
-     * @returns Whether the path or ID corresponds to a builtin file.
+     * The underlying file metadata.
      */
-    isMatchingBuiltinId: (id: string, pathOrId: string) => boolean;
+    meta: Record<string, VirtualFileSystemMetadata | undefined>;
     /**
-     * Checks if a provided string is a valid builtin ID (does not need to already be created in the file system).
-     *
-     * @param id - The ID to check.
-     * @returns Whether the ID is a valid builtin ID.
+     * A map of module ids to their file paths.
      */
-    isValidBuiltinId: (id: string) => boolean;
+    ids: Record<string, string>;
     /**
-     * Check if a path or ID corresponds to a virtual file.
+     * Check if a path or id corresponds to a virtual file **(does not actually exists on disk)**.
      *
-     * @param pathOrId - The path or ID to check.
+     * @param pathOrId - The path or id to check.
      * @param options - Optional parameters for resolving the path.
-     * @returns Whether the path or ID corresponds to a virtual file.
+     * @returns Whether the path or id corresponds to a virtual file **(does not actually exists on disk)**.
      */
-    isVirtualFile: (pathOrId: string, options?: ResolvePathOptions) => boolean;
+    isVirtual: (pathOrId: string, options?: ResolvePathOptions) => boolean;
     /**
-     * Check if a path exists within one of the directories specified in the tsconfig.json's `path` field.
+     * Check if a path or id corresponds to a file written to the file system **(actually exists on disk)**.
      *
-     * @see https://www.typescriptlang.org/tsconfig#paths
-     *
-     * @param pathOrId - The path or ID to check.
-     * @returns Whether the path or ID corresponds to a virtual file.
-     */
-    isTsconfigPath: (pathOrId: string) => boolean;
-    /**
-     * Checks if a given path or ID corresponds to a builtin module file.
-     */
-    isBuiltinFile: (pathOrID: string, options?: ResolvePathOptions) => boolean;
-    /**
-     * Returns a list of builtin module files in the virtual file system.
-     */
-    listBuiltinFiles: () => Promise<VirtualBuiltinFile[]>;
-    /**
-     * Checks if a file exists in the virtual file system (VFS).
+     * @param pathOrId - The path or id to check.
+     * @param options - Optional parameters for resolving the path.
+     * @returns Whether the path or id corresponds to a file written to the file system **(actually exists on disk)**.
      */
-    existsSync: (pathOrId: string) => boolean;
+    isFs: (pathOrId: string, options?: ResolvePathOptions) => boolean;
     /**
      * Checks if a file exists in the virtual file system (VFS).
      *
      * @param path - The path of the file to check.
      * @returns `true` if the file exists, otherwise `false`.
      */
-    fileExistsSync: (path: string) => boolean;
+    isFile: (path: string) => boolean;
     /**
      * Checks if a directory exists in the virtual file system (VFS).
      *
      * @param path - The path of the directory to check.
      * @returns `true` if the directory exists, otherwise `false`.
      */
-    directoryExistsSync: (path: string) => boolean;
+    isDirectory: (path: string) => boolean;
     /**
-     * Checks if a path exists in the virtual file system (VFS).
+     * Check if a path exists within one of the directories specified in the tsconfig.json's `path` field.
      *
-     * @param path - The path to check.
-     * @returns `true` if the path exists, otherwise `false`.
+     * @see https://www.typescriptlang.org/tsconfig#paths
+     *
+     * @param pathOrId - The path or id to check.
+     * @returns Whether the path or id corresponds to a virtual file.
      */
-    pathExistsSync: (path: string) => boolean;
+    isTsconfigPath: (pathOrId: string) => boolean;
+    /**
+     * Checks if a file exists in the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @returns `true` if the file exists, otherwise `false`.
+     */
+    existsSync: (pathOrId: string) => boolean;
     /**
      * Gets the stats of a file in the virtual file system (VFS).
      *
@@ -260,71 +269,28 @@ interface VirtualFileSystemInterface {
     /**
      * Writes a file to the virtual file system (VFS).
      *
-     * @param file - The path to the file.
+     * @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.
      */
-    writeFile: (file: PathOrFileDescriptor, data: string | NodeJS.ArrayBufferView, options?: WriteFileOptions) => Promise<void>;
+    writeFile: (path: PathOrFileDescriptor, data?: WriteFileData, options?: WriteFileOptions) => Promise<void>;
     /**
      * Writes a file to the virtual file system (VFS).
      *
-     * @param file - The path to the file.
+     * @param path - The path to the file.
      * @param data - The contents of the file.
      * @param options - Optional parameters for writing the file.
      */
-    writeFileSync: (file: PathOrFileDescriptor, data: string | NodeJS.ArrayBufferView, options?: WriteFileOptions) => void;
-    /**
-     * Adds a builtin module file to the virtual file system.
-     *
-     * @param id - The unique identifier for the builtin module file.
-     * @param path - The path to the builtin module file.
-     * @param contents - The contents of the builtin module file.
-     * @param options - Optional parameters for writing the builtin module file.
-     */
-    writeBuiltinFile: (id: string, path: string, contents: string, options?: WriteBuiltinFileOptions) => Promise<void>;
-    /**
-     * Adds an entry file to the virtual file system.
-     *
-     * @param name - The unique identifier for the entry file.
-     * @param contents - The contents of the entry file.
-     * @param options - Optional parameters for writing the entry file.
-     */
-    writeEntryFile: (name: string, contents: string, options?: WriteBuiltinFileOptions) => Promise<void>;
-    /**
-     * Writes a file to disk from the physical file system (on disk).
-     *
-     * @param path - The path to the file to write.
-     * @param contents - The contents of the file to write.
-     * @param options - Optional parameters for writing the file.
-     * @returns A promise that resolves when the file is written.
-     */
-    writeFileToDisk: (path: string, contents: string, options?: {
-        skipFormat?: boolean;
-    }) => Promise<void>;
+    writeFileSync: (path: PathOrFileDescriptor, data?: WriteFileData, options?: WriteFileOptions) => void;
     /**
-     * Resolves a path or ID to a file path in the virtual file system.
+     * Resolves a path or id to a file path in the virtual file system.
      *
      * @param pathOrId - The path or id of the file to resolve.
      * @param options - Optional parameters for resolving the path.
      * @returns The resolved path of the file if it exists, otherwise false.
      */
-    resolvePath: (pathOrId: string, options?: ResolvePathOptions) => string | false;
-    /**
-     * Resolves a path or ID to a file path in the virtual file system.
-     *
-     * @param pathOrId - The path or id of the file to resolve.
-     * @returns The resolved path of the file if it exists, otherwise false.
-     */
-    realpathSync: (pathOrId: string) => string;
-    /**
-     * Resolves a path or ID to a builtin module file id in the virtual file system.
-     *
-     * @param pathOrId - The path or id of the file to resolve.
-     * @param paths - Optional array of paths to search for the file.
-     * @returns The resolved id of the builtin module file if it exists, otherwise false.
-     */
-    resolveId: (pathOrId: string) => string | false;
+    resolve: (pathOrId: string, options?: ResolvePathOptions) => string | false;
     /**
      * Resolves a path based on TypeScript's `tsconfig.json` paths.
      *
@@ -343,6 +309,19 @@ interface VirtualFileSystemInterface {
      * @returns The resolved package name if it exists, otherwise undefined.
      */
     resolveTsconfigPathPackage: (path: string) => string | false;
+    /**
+     * Resolves a path or id to a file path in the virtual file system.
+     *
+     * @param pathOrId - The path or id of the file to resolve.
+     * @returns The resolved path of the file if it exists, otherwise false.
+     */
+    realpathSync: (pathOrId: string) => string;
+    /**
+     * Retrieves a partial metadata mapping of all files in the virtual file system (VFS).
+     *
+     * @returns A record mapping file paths to their partial metadata.
+     */
+    getPartialMeta: () => Record<string, Partial<VirtualFileSystemMetadata>>;
     /**
      * A map of cached file paths to their underlying file content.
      */
@@ -357,14 +336,17 @@ interface VirtualFileSystemInterface {
     [__VFS_UNIFIED__]: IUnionFs;
 }
 declare type __ΩVirtualFileExtension = any[];
-declare type __ΩVirtualFile = any[];
-declare type __ΩVirtualBuiltinFile = any[];
 declare type __ΩOutputModeType = any[];
+declare type __ΩVirtualFile = any[];
+declare type __ΩVirtualFileSystemMetadata = any[];
 declare type __ΩResolveFSOptions = any[];
 declare type __ΩMakeDirectoryOptions = any[];
-declare type __ΩResolvePathOptions = any[];
+declare type __ΩPowerlinesWriteFileOptions = any[];
+declare type __ΩNodeWriteFileOptions = any[];
 declare type __ΩWriteFileOptions = any[];
-declare type __ΩWriteBuiltinFileOptions = any[];
+declare type __ΩPowerLinesWriteFileData = any[];
+declare type __ΩWriteFileData = any[];
+declare type __ΩResolvePathOptions = any[];
 declare type __ΩVirtualFileSystemInterface = any[];
 
-export { type MakeDirectoryOptions, type OutputModeType, type ResolveFSOptions, type ResolvePathOptions, type VirtualBuiltinFile, type VirtualFile, type VirtualFileExtension, type VirtualFileSystemInterface, type WriteBuiltinFileOptions, type WriteFileOptions, __VFS_CACHE__, __VFS_INIT__, __VFS_RESOLVER__, __VFS_REVERT__, __VFS_UNIFIED__, __VFS_VIRTUAL__, type __ΩMakeDirectoryOptions, type __ΩOutputModeType, type __ΩResolveFSOptions, type __ΩResolvePathOptions, type __ΩVirtualBuiltinFile, type __ΩVirtualFile, type __ΩVirtualFileExtension, type __ΩVirtualFileSystemInterface, type __ΩWriteBuiltinFileOptions, type __ΩWriteFileOptions };
+export { type MakeDirectoryOptions, type NodeWriteFileOptions, type OutputModeType, type PowerLinesWriteFileData, type PowerlinesWriteFileOptions, type ResolveFSOptions, type ResolvePathOptions, type VirtualFile, type VirtualFileExtension, type VirtualFileSystemInterface, type VirtualFileSystemMetadata, type WriteFileData, type WriteFileOptions, __VFS_CACHE__, __VFS_INIT__, __VFS_RESOLVER__, __VFS_REVERT__, __VFS_UNIFIED__, __VFS_VIRTUAL__, type __ΩMakeDirectoryOptions, type __ΩNodeWriteFileOptions, type __ΩOutputModeType, type __ΩPowerLinesWriteFileData, type __ΩPowerlinesWriteFileOptions, type __ΩResolveFSOptions, type __ΩResolvePathOptions, type __ΩVirtualFile, type __ΩVirtualFileExtension, type __ΩVirtualFileSystemInterface, type __ΩVirtualFileSystemMetadata, type __ΩWriteFileData, type __ΩWriteFileOptions };

package/dist/types/vfs.d.ts

@@ -1,3 +1,4 @@
+import { PrimitiveJsonValue } from '@stryke/json/types';
 import { Volume } from 'memfs';
 import { StatSyncOptions, Stats, PathLike, RmDirOptions, RmOptions, Mode, MakeDirectoryOptions as MakeDirectoryOptions$1, PathOrFileDescriptor, WriteFileOptions as WriteFileOptions$1 } from 'node:fs';
 import { IUnionFs } from 'unionfs';
@@ -9,30 +10,57 @@ declare const __VFS_CACHE__ = "__VFS_CACHE__";
 declare const __VFS_RESOLVER__ = "__VFS_RESOLVER__";
 declare const __VFS_VIRTUAL__ = "__VFS_VIRTUAL__";
 declare const __VFS_UNIFIED__ = "__VFS_UNIFIED__";
+type OutputModeType = "fs" | "virtual";
 interface VirtualFile {
     /**
-     * A virtual path to the file in the virtual file system.
+     * The unique identifier for the virtual file.
+     *
+     * @remarks
+     * If no specific id is provided, it defaults to the file's {@link path}.
      */
-    path: string;
+    id: string;
     /**
-     * The contents of the virtual file.
+     * Additional metadata associated with the virtual file.
      */
-    contents: string;
-}
-interface VirtualBuiltinFile extends VirtualFile {
+    details: Record<string, PrimitiveJsonValue>;
     /**
-     * The unique identifier for the virtual file.
+     * The variant of the file.
      *
      * @remarks
-     * This property is read-only and is set when the file is created.
+     * This string represents the purpose/function of the file in the virtual file system. A potential list of variants includes:
+     * - `builtin`: Indicates that the file is a built-in module provided by the system.
+     * - `entry`: Indicates that the file is an entry point for execution.
+     * - `normal`: Indicates that the file is a standard file without any special role.
      */
-    id: string;
+    variant: string;
+    /**
+     * The output mode of the file.
+     *
+     * @remarks
+     * This indicates whether the file is intended to be written to the actual file system (`fs`) or kept in the virtual file system (`virtual`).
+     */
+    mode: OutputModeType;
+    /**
+     * A virtual (or actual) path to the file in the file system.
+     */
+    path: string;
+    /**
+     * The contents of the file.
+     */
+    code: string | NodeJS.ArrayBufferView;
 }
-type OutputModeType = "fs" | "virtual";
+type VirtualFileSystemMetadata = Pick<VirtualFile, "id" | "details" | "variant" | "mode">;
 interface ResolveFSOptions {
     mode?: OutputModeType;
 }
 type MakeDirectoryOptions = (Mode | MakeDirectoryOptions$1) & ResolveFSOptions;
+interface PowerlinesWriteFileOptions extends ResolveFSOptions {
+    skipFormat?: boolean;
+}
+type NodeWriteFileOptions = WriteFileOptions$1;
+type WriteFileOptions = NodeWriteFileOptions | PowerlinesWriteFileOptions;
+type PowerLinesWriteFileData = Partial<Omit<VirtualFile, "path" | "mode" | "code">> & Pick<VirtualFile, "code">;
+type WriteFileData = string | NodeJS.ArrayBufferView | PowerLinesWriteFileData;
 interface ResolvePathOptions extends ResolveFSOptions {
     /**
      * Should the resolved path include the file extension?
@@ -49,82 +77,63 @@ interface ResolvePathOptions extends ResolveFSOptions {
      */
     type?: "file" | "directory";
 }
-type WriteFileOptions = WriteFileOptions$1 & ResolveFSOptions;
-interface WriteBuiltinFileOptions extends ResolveFSOptions {
-    skipFormat?: boolean;
-}
 interface VirtualFileSystemInterface {
     [__VFS_INIT__]: () => void;
     [__VFS_REVERT__]: () => void;
     /**
-     * The underlying builtin module Ids.
-     */
-    builtinIdMap: Map<string, string>;
-    /**
-     * Checks if a path or ID corresponds to a builtin file.
-     *
-     * @param id - The id of the builtin file to check against.
-     * @param pathOrId - The path or id of the file to check.
-     * @returns Whether the path or ID corresponds to a builtin file.
+     * The underlying file metadata.
      */
-    isMatchingBuiltinId: (id: string, pathOrId: string) => boolean;
+    meta: Record<string, VirtualFileSystemMetadata | undefined>;
     /**
-     * Checks if a provided string is a valid builtin ID (does not need to already be created in the file system).
-     *
-     * @param id - The ID to check.
-     * @returns Whether the ID is a valid builtin ID.
+     * A map of module ids to their file paths.
      */
-    isValidBuiltinId: (id: string) => boolean;
+    ids: Record<string, string>;
     /**
-     * Check if a path or ID corresponds to a virtual file.
+     * Check if a path or id corresponds to a virtual file **(does not actually exists on disk)**.
      *
-     * @param pathOrId - The path or ID to check.
+     * @param pathOrId - The path or id to check.
      * @param options - Optional parameters for resolving the path.
-     * @returns Whether the path or ID corresponds to a virtual file.
+     * @returns Whether the path or id corresponds to a virtual file **(does not actually exists on disk)**.
      */
-    isVirtualFile: (pathOrId: string, options?: ResolvePathOptions) => boolean;
+    isVirtual: (pathOrId: string, options?: ResolvePathOptions) => boolean;
     /**
-     * Check if a path exists within one of the directories specified in the tsconfig.json's `path` field.
+     * Check if a path or id corresponds to a file written to the file system **(actually exists on disk)**.
      *
-     * @see https://www.typescriptlang.org/tsconfig#paths
-     *
-     * @param pathOrId - The path or ID to check.
-     * @returns Whether the path or ID corresponds to a virtual file.
-     */
-    isTsconfigPath: (pathOrId: string) => boolean;
-    /**
-     * Checks if a given path or ID corresponds to a builtin module file.
-     */
-    isBuiltinFile: (pathOrID: string, options?: ResolvePathOptions) => boolean;
-    /**
-     * Returns a list of builtin module files in the virtual file system.
-     */
-    listBuiltinFiles: () => Promise<VirtualBuiltinFile[]>;
-    /**
-     * Checks if a file exists in the virtual file system (VFS).
+     * @param pathOrId - The path or id to check.
+     * @param options - Optional parameters for resolving the path.
+     * @returns Whether the path or id corresponds to a file written to the file system **(actually exists on disk)**.
      */
-    existsSync: (pathOrId: string) => boolean;
+    isFs: (pathOrId: string, options?: ResolvePathOptions) => boolean;
     /**
      * Checks if a file exists in the virtual file system (VFS).
      *
      * @param path - The path of the file to check.
      * @returns `true` if the file exists, otherwise `false`.
      */
-    fileExistsSync: (path: string) => boolean;
+    isFile: (path: string) => boolean;
     /**
      * Checks if a directory exists in the virtual file system (VFS).
      *
      * @param path - The path of the directory to check.
      * @returns `true` if the directory exists, otherwise `false`.
      */
-    directoryExistsSync: (path: string) => boolean;
+    isDirectory: (path: string) => boolean;
     /**
-     * Checks if a path exists in the virtual file system (VFS).
+     * Check if a path exists within one of the directories specified in the tsconfig.json's `path` field.
      *
-     * @param path - The path to check.
-     * @returns `true` if the path exists, otherwise `false`.
+     * @see https://www.typescriptlang.org/tsconfig#paths
+     *
+     * @param pathOrId - The path or id to check.
+     * @returns Whether the path or id corresponds to a virtual file.
      */
-    pathExistsSync: (path: string) => boolean;
+    isTsconfigPath: (pathOrId: string) => boolean;
+    /**
+     * Checks if a file exists in the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @returns `true` if the file exists, otherwise `false`.
+     */
+    existsSync: (pathOrId: string) => boolean;
     /**
      * Gets the stats of a file in the virtual file system (VFS).
      *
@@ -260,71 +269,28 @@ interface VirtualFileSystemInterface {
     /**
      * Writes a file to the virtual file system (VFS).
      *
-     * @param file - The path to the file.
+     * @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.
      */
-    writeFile: (file: PathOrFileDescriptor, data: string | NodeJS.ArrayBufferView, options?: WriteFileOptions) => Promise<void>;
+    writeFile: (path: PathOrFileDescriptor, data?: WriteFileData, options?: WriteFileOptions) => Promise<void>;
     /**
      * Writes a file to the virtual file system (VFS).
      *
-     * @param file - The path to the file.
+     * @param path - The path to the file.
      * @param data - The contents of the file.
      * @param options - Optional parameters for writing the file.
      */
-    writeFileSync: (file: PathOrFileDescriptor, data: string | NodeJS.ArrayBufferView, options?: WriteFileOptions) => void;
-    /**
-     * Adds a builtin module file to the virtual file system.
-     *
-     * @param id - The unique identifier for the builtin module file.
-     * @param path - The path to the builtin module file.
-     * @param contents - The contents of the builtin module file.
-     * @param options - Optional parameters for writing the builtin module file.
-     */
-    writeBuiltinFile: (id: string, path: string, contents: string, options?: WriteBuiltinFileOptions) => Promise<void>;
-    /**
-     * Adds an entry file to the virtual file system.
-     *
-     * @param name - The unique identifier for the entry file.
-     * @param contents - The contents of the entry file.
-     * @param options - Optional parameters for writing the entry file.
-     */
-    writeEntryFile: (name: string, contents: string, options?: WriteBuiltinFileOptions) => Promise<void>;
-    /**
-     * Writes a file to disk from the physical file system (on disk).
-     *
-     * @param path - The path to the file to write.
-     * @param contents - The contents of the file to write.
-     * @param options - Optional parameters for writing the file.
-     * @returns A promise that resolves when the file is written.
-     */
-    writeFileToDisk: (path: string, contents: string, options?: {
-        skipFormat?: boolean;
-    }) => Promise<void>;
+    writeFileSync: (path: PathOrFileDescriptor, data?: WriteFileData, options?: WriteFileOptions) => void;
     /**
-     * Resolves a path or ID to a file path in the virtual file system.
+     * Resolves a path or id to a file path in the virtual file system.
      *
      * @param pathOrId - The path or id of the file to resolve.
      * @param options - Optional parameters for resolving the path.
      * @returns The resolved path of the file if it exists, otherwise false.
      */
-    resolvePath: (pathOrId: string, options?: ResolvePathOptions) => string | false;
-    /**
-     * Resolves a path or ID to a file path in the virtual file system.
-     *
-     * @param pathOrId - The path or id of the file to resolve.
-     * @returns The resolved path of the file if it exists, otherwise false.
-     */
-    realpathSync: (pathOrId: string) => string;
-    /**
-     * Resolves a path or ID to a builtin module file id in the virtual file system.
-     *
-     * @param pathOrId - The path or id of the file to resolve.
-     * @param paths - Optional array of paths to search for the file.
-     * @returns The resolved id of the builtin module file if it exists, otherwise false.
-     */
-    resolveId: (pathOrId: string) => string | false;
+    resolve: (pathOrId: string, options?: ResolvePathOptions) => string | false;
     /**
      * Resolves a path based on TypeScript's `tsconfig.json` paths.
      *
@@ -343,6 +309,19 @@ interface VirtualFileSystemInterface {
      * @returns The resolved package name if it exists, otherwise undefined.
      */
     resolveTsconfigPathPackage: (path: string) => string | false;
+    /**
+     * Resolves a path or id to a file path in the virtual file system.
+     *
+     * @param pathOrId - The path or id of the file to resolve.
+     * @returns The resolved path of the file if it exists, otherwise false.
+     */
+    realpathSync: (pathOrId: string) => string;
+    /**
+     * Retrieves a partial metadata mapping of all files in the virtual file system (VFS).
+     *
+     * @returns A record mapping file paths to their partial metadata.
+     */
+    getPartialMeta: () => Record<string, Partial<VirtualFileSystemMetadata>>;
     /**
      * A map of cached file paths to their underlying file content.
      */
@@ -357,14 +336,17 @@ interface VirtualFileSystemInterface {
     [__VFS_UNIFIED__]: IUnionFs;
 }
 declare type __ΩVirtualFileExtension = any[];
-declare type __ΩVirtualFile = any[];
-declare type __ΩVirtualBuiltinFile = any[];
 declare type __ΩOutputModeType = any[];
+declare type __ΩVirtualFile = any[];
+declare type __ΩVirtualFileSystemMetadata = any[];
 declare type __ΩResolveFSOptions = any[];
 declare type __ΩMakeDirectoryOptions = any[];
-declare type __ΩResolvePathOptions = any[];
+declare type __ΩPowerlinesWriteFileOptions = any[];
+declare type __ΩNodeWriteFileOptions = any[];
 declare type __ΩWriteFileOptions = any[];
-declare type __ΩWriteBuiltinFileOptions = any[];
+declare type __ΩPowerLinesWriteFileData = any[];
+declare type __ΩWriteFileData = any[];
+declare type __ΩResolvePathOptions = any[];
 declare type __ΩVirtualFileSystemInterface = any[];
 
-export { type MakeDirectoryOptions, type OutputModeType, type ResolveFSOptions, type ResolvePathOptions, type VirtualBuiltinFile, type VirtualFile, type VirtualFileExtension, type VirtualFileSystemInterface, type WriteBuiltinFileOptions, type WriteFileOptions, __VFS_CACHE__, __VFS_INIT__, __VFS_RESOLVER__, __VFS_REVERT__, __VFS_UNIFIED__, __VFS_VIRTUAL__, type __ΩMakeDirectoryOptions, type __ΩOutputModeType, type __ΩResolveFSOptions, type __ΩResolvePathOptions, type __ΩVirtualBuiltinFile, type __ΩVirtualFile, type __ΩVirtualFileExtension, type __ΩVirtualFileSystemInterface, type __ΩWriteBuiltinFileOptions, type __ΩWriteFileOptions };
+export { type MakeDirectoryOptions, type NodeWriteFileOptions, type OutputModeType, type PowerLinesWriteFileData, type PowerlinesWriteFileOptions, type ResolveFSOptions, type ResolvePathOptions, type VirtualFile, type VirtualFileExtension, type VirtualFileSystemInterface, type VirtualFileSystemMetadata, type WriteFileData, type WriteFileOptions, __VFS_CACHE__, __VFS_INIT__, __VFS_RESOLVER__, __VFS_REVERT__, __VFS_UNIFIED__, __VFS_VIRTUAL__, type __ΩMakeDirectoryOptions, type __ΩNodeWriteFileOptions, type __ΩOutputModeType, type __ΩPowerLinesWriteFileData, type __ΩPowerlinesWriteFileOptions, type __ΩResolveFSOptions, type __ΩResolvePathOptions, type __ΩVirtualFile, type __ΩVirtualFileExtension, type __ΩVirtualFileSystemInterface, type __ΩVirtualFileSystemMetadata, type __ΩWriteFileData, type __ΩWriteFileOptions };

package/dist/types/vfs.js

@@ -1,4 +1,4 @@
-export { __VFS_CACHE__, __VFS_INIT__, __VFS_RESOLVER__, __VFS_REVERT__, __VFS_UNIFIED__, __VFS_VIRTUAL__ } from '../chunk-ILVCZATT.js';
+export { __VFS_CACHE__, __VFS_INIT__, __VFS_RESOLVER__, __VFS_REVERT__, __VFS_UNIFIED__, __VFS_VIRTUAL__ } from '../chunk-GPPJ2CRE.js';
 import '../chunk-7QVYU63E.js';
 //# sourceMappingURL=vfs.js.map
 //# sourceMappingURL=vfs.js.map

package/dist/unloader.cjs

@@ -2,11 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var chunk6FRFYMLC_cjs = require('./chunk-6FRFYMLC.cjs');
-require('./chunk-UESICHEO.cjs');
-require('./chunk-5ST7UKJF.cjs');
+var chunkS5QFX2GM_cjs = require('./chunk-S5QFX2GM.cjs');
+require('./chunk-2RHPFVYT.cjs');
+require('./chunk-UTVZVGM3.cjs');
 require('./chunk-APVMN2H7.cjs');
-require('./chunk-YE56I7CZ.cjs');
+require('./chunk-5XYGZ3DC.cjs');
 require('./chunk-5VPVJHJO.cjs');
 require('./chunk-PK6SKIKE.cjs');
 
@@ -14,15 +14,15 @@ require('./chunk-PK6SKIKE.cjs');
 
 Object.defineProperty(exports, "default", {
   enumerable: true,
-  get: function () { return chunk6FRFYMLC_cjs.unloader_default; }
+  get: function () { return chunkS5QFX2GM_cjs.unloader_default; }
 });
 Object.defineProperty(exports, "module.exports", {
   enumerable: true,
-  get: function () { return chunk6FRFYMLC_cjs.unloader; }
+  get: function () { return chunkS5QFX2GM_cjs.unloader; }
 });
 Object.defineProperty(exports, "unloader", {
   enumerable: true,
-  get: function () { return chunk6FRFYMLC_cjs.unloader; }
+  get: function () { return chunkS5QFX2GM_cjs.unloader; }
 });
 //# sourceMappingURL=unloader.cjs.map
 //# sourceMappingURL=unloader.cjs.map