vite 6.0.0-beta.1 → 6.0.0-beta.3

package/dist/node/module-runner.d.ts

@@ -1,5 +1,5 @@
 import { ModuleNamespace, ViteHotContext } from '../../types/hot.js';
-import { Update, HotPayload } from '../../types/hmrPayload.js';
+import { HotPayload, Update } from '../../types/hmrPayload.js';
 import { InferCustomEventPayload } from '../../types/customEvent.js';
 
 interface SourceMapLike {
@@ -47,13 +47,13 @@ interface HMRConnection {
     /**
      * Send message to the client.
      */
-    send(messages: string): void;
+    send(messages: HotPayload): void;
 }
 declare class HMRMessenger {
     private connection;
     constructor(connection: HMRConnection);
     private queue;
-    send(message: string): void;
+    send(payload: HotPayload): void;
     flush(): void;
 }
 declare class HMRClient {
@@ -111,20 +111,14 @@ declare class ModuleRunner {
     options: ModuleRunnerOptions;
     evaluator: ModuleEvaluator;
     private debug?;
-    /**
-     * Holds the cache of modules
-     * Keys of the map are ids
-     */
-    moduleCache: ModuleCacheMap;
+    evaluatedModules: EvaluatedModules;
     hmrClient?: HMRClient;
-    private readonly urlToIdMap;
-    private readonly fileToIdMap;
     private readonly envProxy;
     private readonly transport;
     private readonly resetSourceMapSupport?;
     private readonly root;
-    private readonly moduleInfoCache;
-    private destroyed;
+    private readonly concurrentModuleNodePromises;
+    private closed;
     constructor(options: ModuleRunnerOptions, evaluator: ModuleEvaluator, debug?: ModuleRunnerDebugger | undefined);
     /**
      * URL to execute. Accepts file path, server path or id relative to the root.
@@ -138,18 +132,18 @@ declare class ModuleRunner {
      * Clears all caches, removes all HMR listeners, and resets source map support.
      * This method doesn't stop the HMR connection.
      */
-    destroy(): Promise<void>;
+    close(): Promise<void>;
     /**
-     * Returns `true` if the runtime has been destroyed by calling `destroy()` method.
+     * Returns `true` if the runtime has been closed by calling `close()` method.
      */
-    isDestroyed(): boolean;
+    isClosed(): boolean;
     private processImport;
     private isCircularModule;
     private isCircularImport;
     private cachedRequest;
     private cachedModule;
     private getModuleInformation;
-    protected directRequest(id: string, mod: ModuleCache, _callstack: string[]): Promise<any>;
+    protected directRequest(url: string, mod: EvaluatedModuleNode, _callstack: string[]): Promise<any>;
 }
 
 interface RetrieveFileHandler {
@@ -202,31 +196,23 @@ interface ModuleRunnerContext {
     [ssrImportMetaKey]: ModuleRunnerImportMeta;
 }
 interface ModuleEvaluator {
+    /**
+     * Number of prefixed lines in the transformed code.
+     */
+    startOffset?: number;
     /**
      * Run code that was transformed by Vite.
      * @param context Function context
      * @param code Transformed code
-     * @param id ID that was used to fetch the module
+     * @param module The module node
      */
-    runInlinedModule(context: ModuleRunnerContext, code: string, id: string): Promise<any>;
+    runInlinedModule(context: ModuleRunnerContext, code: string, module: Readonly<EvaluatedModuleNode>): Promise<any>;
     /**
      * Run externalized module.
      * @param file File URL to the external module
      */
     runExternalModule(file: string): Promise<any>;
 }
-interface ModuleCache {
-    promise?: Promise<any>;
-    exports?: any;
-    evaluated?: boolean;
-    map?: DecodedMap;
-    meta?: ResolvedResult;
-    /**
-     * Module ids that imports this module
-     */
-    importers?: Set<string>;
-    imports?: Set<string>;
-}
 type FetchResult = CachedFetchResult | ExternalFetchResult | ViteFetchResult;
 interface CachedFetchResult {
     /**
@@ -246,7 +232,7 @@ interface ExternalFetchResult {
      * Type of the module. Will be used to determine if import statement is correct.
      * For example, if Vite needs to throw an error if variable is not actually exported
      */
-    type?: 'module' | 'commonjs' | 'builtin' | 'network';
+    type: 'module' | 'commonjs' | 'builtin' | 'network';
 }
 interface ViteFetchResult {
     /**
@@ -263,7 +249,11 @@ interface ViteFetchResult {
     /**
      * Module ID in the server module graph.
      */
-    serverId: string;
+    id: string;
+    /**
+     * Module URL used in the import.
+     */
+    url: string;
     /**
      * Invalidate module on the client side.
      */
@@ -271,10 +261,12 @@ interface ViteFetchResult {
 }
 type ResolvedResult = (ExternalFetchResult | ViteFetchResult) & {
     url: string;
+    id: string;
 };
 type FetchFunction = (id: string, importer?: string, options?: FetchFunctionOptions) => Promise<FetchResult>;
 interface FetchFunctionOptions {
     cached?: boolean;
+    startOffset?: number;
 }
 interface ModuleRunnerHmr {
     /**
@@ -308,7 +300,7 @@ interface ModuleRunnerOptions {
     /**
      * Custom module cache. If not provided, creates a separate module cache for each ModuleRunner instance.
      */
-    moduleCache?: ModuleCacheMap;
+    evaluatedModules?: EvaluatedModules;
 }
 interface ImportMetaEnv {
     [key: string]: any;
@@ -319,36 +311,66 @@ interface ImportMetaEnv {
     SSR: boolean;
 }
 
-declare class ModuleCacheMap extends Map<string, ModuleCache> {
-    private root;
-    constructor(root: string, entries?: [string, ModuleCache][]);
-    normalize(fsPath: string): string;
+declare class EvaluatedModuleNode {
+    id: string;
+    url: string;
+    importers: Set<string>;
+    imports: Set<string>;
+    evaluated: boolean;
+    meta: ResolvedResult | undefined;
+    promise: Promise<any> | undefined;
+    exports: any | undefined;
+    file: string;
+    map: DecodedMap | undefined;
+    constructor(id: string, url: string);
+}
+declare class EvaluatedModules {
+    readonly idToModuleMap: Map<string, EvaluatedModuleNode>;
+    readonly fileToModulesMap: Map<string, Set<EvaluatedModuleNode>>;
+    readonly urlToIdModuleMap: Map<string, EvaluatedModuleNode>;
+    /**
+     * Returns the module node by the resolved module ID. Usually, module ID is
+     * the file system path with query and/or hash. It can also be a virtual module.
+     *
+     * Module runner graph will have 1 to 1 mapping with the server module graph.
+     * @param id Resolved module ID
+     */
+    getModuleById(id: string): EvaluatedModuleNode | undefined;
     /**
-     * Assign partial data to the map
+     * Returns all modules related to the file system path. Different modules
+     * might have different query parameters or hash, so it's possible to have
+     * multiple modules for the same file.
+     * @param file The file system path of the module
      */
-    update(fsPath: string, mod: ModuleCache): this;
-    setByModuleId(modulePath: string, mod: ModuleCache): this;
-    set(fsPath: string, mod: ModuleCache): this;
-    getByModuleId(modulePath: string): ModuleCache;
-    get(fsPath: string): ModuleCache;
-    deleteByModuleId(modulePath: string): boolean;
-    delete(fsPath: string): boolean;
-    invalidateUrl(id: string): void;
-    invalidateModule(module: ModuleCache): void;
+    getModulesByFile(file: string): Set<EvaluatedModuleNode> | undefined;
     /**
-     * Invalidate modules that dependent on the given modules, up to the main entry
+     * Returns the module node by the URL that was used in the import statement.
+     * Unlike module graph on the server, the URL is not resolved and is used as is.
+     * @param url Server URL that was used in the import statement
      */
-    invalidateDepTree(ids: string[] | Set<string>, invalidated?: Set<string>): Set<string>;
+    getModuleByUrl(url: string): EvaluatedModuleNode | undefined;
     /**
-     * Invalidate dependency modules of the given modules, down to the bottom-level dependencies
+     * Ensure that module is in the graph. If the module is already in the graph,
+     * it will return the existing module node. Otherwise, it will create a new
+     * module node and add it to the graph.
+     * @param id Resolved module ID
+     * @param url URL that was used in the import statement
      */
-    invalidateSubDepTree(ids: string[] | Set<string>, invalidated?: Set<string>): Set<string>;
-    getSourceMap(moduleId: string): null | DecodedMap;
+    ensureModule(id: string, url: string): EvaluatedModuleNode;
+    invalidateModule(node: EvaluatedModuleNode): void;
+    /**
+     * Extracts the inlined source map from the module code and returns the decoded
+     * source map. If the source map is not inlined, it will return null.
+     * @param id Resolved module ID
+     */
+    getModuleSourceMapById(id: string): DecodedMap | null;
+    clear(): void;
 }
 
 declare class ESModulesEvaluator implements ModuleEvaluator {
+    startOffset: number;
     runInlinedModule(context: ModuleRunnerContext, code: string): Promise<any>;
     runExternalModule(filepath: string): Promise<any>;
 }
 
-export { ESModulesEvaluator, type FetchFunction, type FetchFunctionOptions, type FetchResult, type HMRConnection, type HMRLogger, type ModuleCache, ModuleCacheMap, type ModuleEvaluator, ModuleRunner, type ModuleRunnerContext, type ModuleRunnerHMRConnection, type ModuleRunnerHmr, type ModuleRunnerImportMeta, type ModuleRunnerOptions, RemoteRunnerTransport, type ResolvedResult, type RunnerTransport, type SSRImportMetadata, ssrDynamicImportKey, ssrExportAllKey, ssrImportKey, ssrImportMetaKey, ssrModuleExportsKey };
+export { ESModulesEvaluator, EvaluatedModuleNode, EvaluatedModules, type FetchFunction, type FetchFunctionOptions, type FetchResult, type HMRConnection, type HMRLogger, type ModuleEvaluator, ModuleRunner, type ModuleRunnerContext, type ModuleRunnerHMRConnection, type ModuleRunnerHmr, type ModuleRunnerImportMeta, type ModuleRunnerOptions, RemoteRunnerTransport, type ResolvedResult, type RunnerTransport, type SSRImportMetadata, ssrDynamicImportKey, ssrExportAllKey, ssrImportKey, ssrImportMetaKey, ssrModuleExportsKey };