vite 2.9.9 → 3.0.0-alpha.2

package/dist/node/server/index.d.ts

@@ -0,0 +1,198 @@
+/// <reference types="node" />
+import type * as http from 'http';
+import type { FSWatcher, WatchOptions } from 'types/chokidar';
+import type { Connect } from 'types/connect';
+import type { SourceMap } from 'rollup';
+import type { CommonServerOptions } from '../http';
+import type { InlineConfig, ResolvedConfig } from '../config';
+import type { OptimizedDeps } from '../optimizer';
+import type { Logger } from '../logger';
+import type { PluginContainer } from './pluginContainer';
+import type { WebSocketServer } from './ws';
+import { ModuleGraph } from './moduleGraph';
+import type { HmrOptions } from './hmr';
+import type { TransformOptions, TransformResult } from './transformRequest';
+export { searchForWorkspaceRoot } from './searchRoot';
+export interface ServerOptions extends CommonServerOptions {
+    /**
+     * Force dep pre-optimization regardless of whether deps have changed.
+     */
+    force?: boolean;
+    /**
+     * Configure HMR-specific options (port, host, path & protocol)
+     */
+    hmr?: HmrOptions | boolean;
+    /**
+     * chokidar watch options
+     * https://github.com/paulmillr/chokidar#api
+     */
+    watch?: WatchOptions;
+    /**
+     * Create Vite dev server to be used as a middleware in an existing server
+     */
+    middlewareMode?: boolean | 'html' | 'ssr';
+    /**
+     * Prepend this folder to http requests, for use when proxying vite as a subfolder
+     * Should start and end with the `/` character
+     */
+    base?: string;
+    /**
+     * Options for files served via '/\@fs/'.
+     */
+    fs?: FileSystemServeOptions;
+    /**
+     * Origin for the generated asset URLs.
+     *
+     * @example `http://127.0.0.1:8080`
+     */
+    origin?: string;
+    /**
+     * Pre-transform known direct imports
+     * @default true
+     */
+    preTransformRequests?: boolean;
+}
+export interface ResolvedServerOptions extends ServerOptions {
+    fs: Required<FileSystemServeOptions>;
+}
+export interface FileSystemServeOptions {
+    /**
+     * Strictly restrict file accessing outside of allowing paths.
+     *
+     * Set to `false` to disable the warning
+     *
+     * @default true
+     */
+    strict?: boolean;
+    /**
+     * Restrict accessing files outside the allowed directories.
+     *
+     * Accepts absolute path or a path relative to project root.
+     * Will try to search up for workspace root by default.
+     */
+    allow?: string[];
+    /**
+     * Restrict accessing files that matches the patterns.
+     *
+     * This will have higher priority than `allow`.
+     * Glob patterns are supported.
+     *
+     * @default ['.env', '.env.*', '*.crt', '*.pem']
+     */
+    deny?: string[];
+}
+export declare type ServerHook = (server: ViteDevServer) => (() => void) | void | Promise<(() => void) | void>;
+export interface ViteDevServer {
+    /**
+     * The resolved vite config object
+     */
+    config: ResolvedConfig;
+    /**
+     * A connect app instance.
+     * - Can be used to attach custom middlewares to the dev server.
+     * - Can also be used as the handler function of a custom http server
+     *   or as a middleware in any connect-style Node.js frameworks
+     *
+     * https://github.com/senchalabs/connect#use-middleware
+     */
+    middlewares: Connect.Server;
+    /**
+     * native Node http server instance
+     * will be null in middleware mode
+     */
+    httpServer: http.Server | null;
+    /**
+     * chokidar watcher instance
+     * https://github.com/paulmillr/chokidar#api
+     */
+    watcher: FSWatcher;
+    /**
+     * web socket server with `send(payload)` method
+     */
+    ws: WebSocketServer;
+    /**
+     * Rollup plugin container that can run plugin hooks on a given file
+     */
+    pluginContainer: PluginContainer;
+    /**
+     * Module graph that tracks the import relationships, url to file mapping
+     * and hmr state.
+     */
+    moduleGraph: ModuleGraph;
+    /**
+     * Programmatically resolve, load and transform a URL and get the result
+     * without going through the http request pipeline.
+     */
+    transformRequest(url: string, options?: TransformOptions): Promise<TransformResult | null>;
+    /**
+     * Apply vite built-in HTML transforms and any plugin HTML transforms.
+     */
+    transformIndexHtml(url: string, html: string, originalUrl?: string): Promise<string>;
+    /**
+     * Transform module code into SSR format.
+     */
+    ssrTransform(code: string, inMap: SourceMap | null, url: string): Promise<TransformResult | null>;
+    /**
+     * Load a given URL as an instantiated module for SSR.
+     */
+    ssrLoadModule(url: string, opts?: {
+        fixStacktrace?: boolean;
+    }): Promise<Record<string, any>>;
+    /**
+     * Returns a fixed version of the given stack
+     */
+    ssrRewriteStacktrace(stack: string): string;
+    /**
+     * Mutates the given SSR error by rewriting the stacktrace
+     */
+    ssrFixStacktrace(e: Error): void;
+    /**
+     * Start the server.
+     */
+    listen(port?: number, isRestart?: boolean): Promise<ViteDevServer>;
+    /**
+     * Stop the server.
+     */
+    close(): Promise<void>;
+    /**
+     * Print server urls
+     */
+    printUrls(): void;
+    /**
+     * Restart the server.
+     *
+     * @param forceOptimize - force the optimizer to re-bundle, same as --force cli flag
+     */
+    restart(forceOptimize?: boolean): Promise<void>;
+    /**
+     * @internal
+     */
+    _optimizedDeps: OptimizedDeps | null;
+    /**
+     * @internal
+     */
+    _importGlobMap: Map<string, string[][]>;
+    /**
+     * Deps that are externalized
+     * @internal
+     */
+    _ssrExternals: string[] | null;
+    /**
+     * @internal
+     */
+    _restartPromise: Promise<void> | null;
+    /**
+     * @internal
+     */
+    _forceOptimizeOnRestart: boolean;
+    /**
+     * @internal
+     */
+    _pendingRequests: Map<string, {
+        request: Promise<TransformResult | null>;
+        timestamp: number;
+        abort: () => void;
+    }>;
+}
+export declare function createServer(inlineConfig?: InlineConfig): Promise<ViteDevServer>;
+export declare function resolveServerOptions(root: string, raw: ServerOptions | undefined, logger: Logger): ResolvedServerOptions;

package/dist/node/server/middlewares/base.d.ts

@@ -0,0 +1,3 @@
+import type { Connect } from 'types/connect';
+import type { ViteDevServer } from '..';
+export declare function baseMiddleware({ config }: ViteDevServer): Connect.NextHandleFunction;

package/dist/node/server/middlewares/compression.d.ts

@@ -0,0 +1 @@
+export default function compression(): (req: any, res: any, next?: () => void) => void;

package/dist/node/server/middlewares/error.d.ts

@@ -0,0 +1,8 @@
+import type { RollupError } from 'rollup';
+import type { Connect } from 'types/connect';
+import type { ErrorPayload } from 'types/hmrPayload';
+import type { ViteDevServer } from '../..';
+export declare function prepareError(err: Error | RollupError): ErrorPayload['err'];
+export declare function buildErrorMessage(err: RollupError, args?: string[], includeStack?: boolean): string;
+export declare function logError(server: ViteDevServer, err: RollupError): void;
+export declare function errorMiddleware(server: ViteDevServer, allowNext?: boolean): Connect.ErrorHandleFunction;

package/dist/node/server/middlewares/indexHtml.d.ts

@@ -0,0 +1,4 @@
+import type { Connect } from 'types/connect';
+import type { ViteDevServer } from '../..';
+export declare function createDevHtmlTransformFn(server: ViteDevServer): (url: string, html: string, originalUrl: string) => Promise<string>;
+export declare function indexHtmlMiddleware(server: ViteDevServer): Connect.NextHandleFunction;

package/dist/node/server/middlewares/proxy.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="node" />
+import type * as http from 'http';
+import type { Connect } from 'types/connect';
+import type { HttpProxy } from 'types/http-proxy';
+import type { CommonServerOptions, ResolvedConfig } from '../..';
+export interface ProxyOptions extends HttpProxy.ServerOptions {
+    /**
+     * rewrite path
+     */
+    rewrite?: (path: string) => string;
+    /**
+     * configure the proxy server (e.g. listen to events)
+     */
+    configure?: (proxy: HttpProxy.Server, options: ProxyOptions) => void;
+    /**
+     * webpack-dev-server style bypass function
+     */
+    bypass?: (req: http.IncomingMessage, res: http.ServerResponse, options: ProxyOptions) => void | null | undefined | false | string;
+}
+export declare function proxyMiddleware(httpServer: http.Server | null, options: NonNullable<CommonServerOptions['proxy']>, config: ResolvedConfig): Connect.NextHandleFunction;

package/dist/node/server/middlewares/spaFallback.d.ts

@@ -0,0 +1,2 @@
+import type { Connect } from 'types/connect';
+export declare function spaFallbackMiddleware(root: string): Connect.NextHandleFunction;

package/dist/node/server/middlewares/static.d.ts

@@ -0,0 +1,6 @@
+import type { Connect } from 'types/connect';
+import type { ViteDevServer } from '../..';
+export declare function servePublicMiddleware(dir: string): Connect.NextHandleFunction;
+export declare function serveStaticMiddleware(dir: string, server: ViteDevServer): Connect.NextHandleFunction;
+export declare function serveRawFsMiddleware(server: ViteDevServer): Connect.NextHandleFunction;
+export declare function isFileServingAllowed(url: string, server: ViteDevServer): boolean;

package/dist/node/server/middlewares/time.d.ts

@@ -0,0 +1,2 @@
+import type { Connect } from 'types/connect';
+export declare function timeMiddleware(root: string): Connect.NextHandleFunction;

package/dist/node/server/middlewares/transform.d.ts

@@ -0,0 +1,3 @@
+import type { Connect } from 'types/connect';
+import type { ViteDevServer } from '..';
+export declare function transformMiddleware(server: ViteDevServer): Connect.NextHandleFunction;

package/dist/node/server/moduleGraph.d.ts

@@ -0,0 +1,55 @@
+import type { ModuleInfo, PartialResolvedId } from 'rollup';
+import type { TransformResult } from './transformRequest';
+export declare class ModuleNode {
+    /**
+     * Public served url path, starts with /
+     */
+    url: string;
+    /**
+     * Resolved file system path + query
+     */
+    id: string | null;
+    file: string | null;
+    type: 'js' | 'css';
+    info?: ModuleInfo;
+    meta?: Record<string, any>;
+    importers: Set<ModuleNode>;
+    importedModules: Set<ModuleNode>;
+    acceptedHmrDeps: Set<ModuleNode>;
+    isSelfAccepting?: boolean;
+    transformResult: TransformResult | null;
+    ssrTransformResult: TransformResult | null;
+    ssrModule: Record<string, any> | null;
+    ssrError: Error | null;
+    lastHMRTimestamp: number;
+    lastInvalidationTimestamp: number;
+    constructor(url: string);
+}
+export declare type ResolvedUrl = [
+    url: string,
+    resolvedId: string,
+    meta: object | null | undefined
+];
+export declare class ModuleGraph {
+    private resolveId;
+    urlToModuleMap: Map<string, ModuleNode>;
+    idToModuleMap: Map<string, ModuleNode>;
+    fileToModulesMap: Map<string, Set<ModuleNode>>;
+    safeModulesPath: Set<string>;
+    constructor(resolveId: (url: string, ssr: boolean) => Promise<PartialResolvedId | null>);
+    getModuleByUrl(rawUrl: string, ssr?: boolean): Promise<ModuleNode | undefined>;
+    getModuleById(id: string): ModuleNode | undefined;
+    getModulesByFile(file: string): Set<ModuleNode> | undefined;
+    onFileChange(file: string): void;
+    invalidateModule(mod: ModuleNode, seen?: Set<ModuleNode>, timestamp?: number): void;
+    invalidateAll(): void;
+    /**
+     * Update the module graph based on a module's updated imports information
+     * If there are dependencies that no longer have any importers, they are
+     * returned as a Set.
+     */
+    updateModuleInfo(mod: ModuleNode, importedModules: Set<string | ModuleNode>, acceptedModules: Set<string | ModuleNode>, isSelfAccepting: boolean, ssr?: boolean): Promise<Set<ModuleNode> | undefined>;
+    ensureEntryFromUrl(rawUrl: string, ssr?: boolean): Promise<ModuleNode>;
+    createFileOnlyEntry(file: string): ModuleNode;
+    resolveUrl(url: string, ssr?: boolean): Promise<ResolvedUrl>;
+}

package/dist/node/server/openBrowser.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The following is modified based on source found in
+ * https://github.com/facebook/create-react-app
+ *
+ * MIT Licensed
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * https://github.com/facebook/create-react-app/blob/master/LICENSE
+ *
+ */
+import type { Logger } from '../logger';
+/**
+ * Reads the BROWSER environment variable and decides what to do with it.
+ * Returns true if it opened a browser or ran a node.js script, otherwise false.
+ */
+export declare function openBrowser(url: string, opt: string | true, logger: Logger): boolean;

package/dist/node/server/pluginContainer.d.ts

@@ -0,0 +1,41 @@
+/**
+ * This file is refactored into TypeScript based on
+ * https://github.com/preactjs/wmr/blob/main/packages/wmr/src/lib/rollup-plugin-container.js
+ */
+import type { InputOptions, LoadResult, ModuleInfo, OutputOptions, PartialResolvedId, SourceDescription } from 'rollup';
+import * as acorn from 'acorn';
+import type { FSWatcher } from 'chokidar';
+import type { Plugin } from '../plugin';
+import type { ResolvedConfig } from '../config';
+import type { ModuleGraph } from './moduleGraph';
+export interface PluginContainerOptions {
+    cwd?: string;
+    output?: OutputOptions;
+    modules?: Map<string, {
+        info: ModuleInfo;
+    }>;
+    writeFile?: (name: string, source: string | Uint8Array) => void;
+}
+export interface PluginContainer {
+    options: InputOptions;
+    getModuleInfo(id: string): ModuleInfo | null;
+    buildStart(options: InputOptions): Promise<void>;
+    resolveId(id: string, importer?: string, options?: {
+        skip?: Set<Plugin>;
+        ssr?: boolean;
+        /**
+         * @internal
+         */
+        scan?: boolean;
+    }): Promise<PartialResolvedId | null>;
+    transform(code: string, id: string, options?: {
+        inMap?: SourceDescription['map'];
+        ssr?: boolean;
+    }): Promise<SourceDescription | null>;
+    load(id: string, options?: {
+        ssr?: boolean;
+    }): Promise<LoadResult | null>;
+    close(): Promise<void>;
+}
+export declare let parser: typeof acorn.Parser;
+export declare function createPluginContainer({ plugins, logger, root, build: { rollupOptions } }: ResolvedConfig, moduleGraph?: ModuleGraph, watcher?: FSWatcher): Promise<PluginContainer>;

package/dist/node/server/searchRoot.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Search up for the nearest `package.json`
+ */
+export declare function searchForPackageRoot(current: string, root?: string): string;
+/**
+ * Search up for the nearest workspace root
+ */
+export declare function searchForWorkspaceRoot(current: string, root?: string): string;

package/dist/node/server/send.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="node" />
+import type { IncomingMessage, OutgoingHttpHeaders, ServerResponse } from 'http';
+import type { SourceMap } from 'rollup';
+export interface SendOptions {
+    etag?: string;
+    cacheControl?: string;
+    headers?: OutgoingHttpHeaders;
+    map?: SourceMap | null;
+}
+export declare function send(req: IncomingMessage, res: ServerResponse, content: string | Buffer, type: string, options: SendOptions): void;

package/dist/node/server/sourcemap.d.ts

@@ -0,0 +1,11 @@
+import type { SourceMap } from 'rollup';
+import type { Logger } from '../logger';
+interface SourceMapLike {
+    sources: string[];
+    sourcesContent?: (string | null)[];
+    sourceRoot?: string;
+}
+export declare function injectSourcesContent(map: SourceMapLike, file: string, logger: Logger): Promise<void>;
+export declare function genSourceMapUrl(map: SourceMap | string | undefined): string;
+export declare function getCodeWithSourcemap(type: 'js' | 'css', code: string, map: SourceMap | null): string;
+export {};

package/dist/node/server/transformRequest.d.ts

@@ -0,0 +1,14 @@
+import type { SourceMap } from 'rollup';
+import type { ViteDevServer } from '..';
+export interface TransformResult {
+    code: string;
+    map: SourceMap | null;
+    etag?: string;
+    deps?: string[];
+    dynamicDeps?: string[];
+}
+export interface TransformOptions {
+    ssr?: boolean;
+    html?: boolean;
+}
+export declare function transformRequest(url: string, server: ViteDevServer, options?: TransformOptions): Promise<TransformResult | null>;

package/dist/node/server/ws.d.ts

@@ -0,0 +1,55 @@
+/// <reference types="node" />
+import type { Server } from 'http';
+import type { ServerOptions as HttpsServerOptions } from 'https';
+import type { WebSocket as WebSocketTypes } from 'types/ws';
+import type { CustomPayload, HMRPayload } from 'types/hmrPayload';
+import type { InferCustomEventPayload } from 'types/customEvent';
+import type { ResolvedConfig } from '..';
+export declare const HMR_HEADER = "vite-hmr";
+export declare type WebSocketCustomListener<T> = (data: T, client: WebSocketClient) => void;
+export interface WebSocketServer {
+    /**
+     * Get all connected clients.
+     */
+    clients: Set<WebSocketClient>;
+    /**
+     * Boardcast events to all clients
+     */
+    send(payload: HMRPayload): void;
+    /**
+     * Send custom event
+     */
+    send<T extends string>(event: T, payload?: InferCustomEventPayload<T>): void;
+    /**
+     * Disconnect all clients and terminate the server.
+     */
+    close(): Promise<void>;
+    /**
+     * Handle custom event emitted by `import.meta.hot.send`
+     */
+    on: WebSocketTypes.Server['on'] & {
+        <T extends string>(event: T, listener: WebSocketCustomListener<InferCustomEventPayload<T>>): void;
+    };
+    /**
+     * Unregister event listener.
+     */
+    off: WebSocketTypes.Server['off'] & {
+        (event: string, listener: Function): void;
+    };
+}
+export interface WebSocketClient {
+    /**
+     * Send event to the client
+     */
+    send(payload: HMRPayload): void;
+    /**
+     * Send custom event
+     */
+    send(event: string, payload?: CustomPayload['data']): void;
+    /**
+     * The raw WebSocket instance
+     * @advanced
+     */
+    socket: WebSocketTypes;
+}
+export declare function createWebSocketServer(server: Server | null, config: ResolvedConfig, httpsOptions?: HttpsServerOptions): WebSocketServer;

package/dist/node/ssr/ssrExternal.d.ts

@@ -0,0 +1,11 @@
+import type { ResolvedConfig } from '..';
+/**
+ * Converts "parent > child" syntax to just "child"
+ */
+export declare function stripNesting(packages: string[]): string[];
+/**
+ * Heuristics for determining whether a dependency should be externalized for
+ * server-side rendering.
+ */
+export declare function resolveSSRExternal(config: ResolvedConfig, knownImports: string[]): string[];
+export declare function shouldExternalizeForSSR(id: string, externals: string[]): boolean;

package/dist/node/ssr/ssrManifestPlugin.d.ts

@@ -0,0 +1,3 @@
+import type { ResolvedConfig } from '..';
+import type { Plugin } from '../plugin';
+export declare function ssrManifestPlugin(config: ResolvedConfig): Plugin;

package/dist/node/ssr/ssrModuleLoader.d.ts

@@ -0,0 +1,7 @@
+import type { ViteDevServer } from '../server';
+interface SSRContext {
+    global: typeof globalThis;
+}
+declare type SSRModule = Record<string, any>;
+export declare function ssrLoadModule(url: string, server: ViteDevServer, context?: SSRContext, urlStack?: string[], fixStacktrace?: boolean): Promise<SSRModule>;
+export {};

package/dist/node/ssr/ssrStacktrace.d.ts

@@ -0,0 +1,3 @@
+import type { ModuleGraph } from '../server/moduleGraph';
+export declare function ssrRewriteStacktrace(stack: string, moduleGraph: ModuleGraph): string;
+export declare function rebindErrorStacktrace(e: Error, stacktrace: string): void;

package/dist/node/ssr/ssrTransform.d.ts

@@ -0,0 +1,14 @@
+import type { SourceMap } from 'rollup';
+import type { TransformResult } from '../server/transformRequest';
+interface TransformOptions {
+    json?: {
+        stringify?: boolean;
+    };
+}
+export declare const ssrModuleExportsKey = "__vite_ssr_exports__";
+export declare const ssrImportKey = "__vite_ssr_import__";
+export declare const ssrDynamicImportKey = "__vite_ssr_dynamic_import__";
+export declare const ssrExportAllKey = "__vite_ssr_exportAll__";
+export declare const ssrImportMetaKey = "__vite_ssr_import_meta__";
+export declare function ssrTransform(code: string, inMap: SourceMap | null, url: string, options?: TransformOptions): Promise<TransformResult | null>;
+export {};