@rspack/core 1.3.5 → 1.3.7

package/dist/builtin-plugin/CircularDependencyRspackPlugin.d.ts

@@ -1,5 +1,8 @@
-import { BuiltinPluginName, type JsCompilation } from "@rspack/binding";
+import { type BuiltinPlugin, BuiltinPluginName } from "@rspack/binding";
+import type { Compilation } from "../Compilation";
+import type { Compiler } from "../Compiler";
 import type { Module } from "../Module";
+import { RspackBuiltinPlugin } from "./base";
 export type CircularDependencyRspackPluginOptions = {
     /**
      * When `true`, the plugin will emit `ERROR` diagnostics rather than the
@@ -33,27 +36,24 @@ export type CircularDependencyRspackPluginOptions = {
      * Called once for every detected cycle. Providing this handler overrides the
      * default behavior of adding diagnostics to the compilation.
      */
-    onDetected?(entrypoint: Module, modules: string[], compilation: JsCompilation): void;
+    onDetected?(entrypoint: Module, modules: string[], compilation: Compilation): void;
     /**
      * Called once for every detected cycle that was ignored because of a rule,
      * either from `exclude` or `ignoredConnections`.
      */
-    onIgnored?(entrypoint: Module, modules: string[], compilation: JsCompilation): void;
+    onIgnored?(entrypoint: Module, modules: string[], compilation: Compilation): void;
     /**
      * Called before cycle detection begins.
      */
-    onStart?(compilation: JsCompilation): void;
+    onStart?(compilation: Compilation): void;
     /**
      * Called after cycle detection finishes.
      */
-    onEnd?(compilation: JsCompilation): void;
-};
-export declare const CircularDependencyRspackPlugin: {
-    new (options: CircularDependencyRspackPluginOptions): {
-        name: BuiltinPluginName;
-        _args: [options: CircularDependencyRspackPluginOptions];
-        affectedHooks: "done" | "make" | "compile" | "emit" | "afterEmit" | "invalid" | "thisCompilation" | "afterDone" | "compilation" | "normalModuleFactory" | "contextModuleFactory" | "initialize" | "shouldEmit" | "infrastructureLog" | "beforeRun" | "run" | "assetEmitted" | "failed" | "shutdown" | "watchRun" | "watchClose" | "environment" | "afterEnvironment" | "afterPlugins" | "afterResolvers" | "beforeCompile" | "afterCompile" | "finishMake" | "entryOption" | "additionalPass" | undefined;
-        raw(compiler: import("..").Compiler): import("@rspack/binding").BuiltinPlugin;
-        apply(compiler: import("..").Compiler): void;
-    };
+    onEnd?(compilation: Compilation): void;
 };
+export declare class CircularDependencyRspackPlugin extends RspackBuiltinPlugin {
+    name: BuiltinPluginName;
+    _options: CircularDependencyRspackPluginOptions;
+    constructor(options: CircularDependencyRspackPluginOptions);
+    raw(compiler: Compiler): BuiltinPlugin;
+}

package/dist/builtin-plugin/html-plugin/options.d.ts

@@ -73,7 +73,7 @@ export type HtmlRspackPluginOptions = {
      */
     hash?: boolean;
 };
-export declare function validateHtmlPluginOptions(options: HtmlRspackPluginOptions): void;
+export declare function validateHtmlPluginOptions(options: HtmlRspackPluginOptions): string | null;
 export declare const getPluginOptions: (compilation: Compilation) => HtmlRspackPluginOptions | undefined;
 export declare const setPluginOptions: (compilation: Compilation, options: HtmlRspackPluginOptions) => void;
 export declare const cleanPluginOptions: (compilation: Compilation) => void;

package/dist/builtin-plugin/lazy-compilation/middleware.d.ts

@@ -1,4 +1,4 @@
-import type { Middleware } from "webpack-dev-server";
 import type { Compiler, LazyCompilationOptions } from "../..";
+import type { Middleware } from "../../config/devServer";
 export declare const LAZY_COMPILATION_PREFIX = "/lazy-compilation-using-";
 export declare const lazyCompilationMiddleware: (compiler: Compiler, userOptions?: LazyCompilationOptions | boolean) => Middleware;

package/dist/config/devServer.d.ts

@@ -0,0 +1,207 @@
+/**
+ * The following code is modified based on
+ * https://github.com/webpack/webpack-dev-server/blob/6045b1e9d63078fb24cac52eb361b7356944cddd/types/lib/Server.d.ts
+ *
+ * MIT Licensed
+ * Author Tobias Koppers @sokra
+ * Copyright (c) JS Foundation and other contributors
+ * https://github.com/webpack/webpack-dev-server/blob/master/LICENSE
+ */
+import type { Compiler, MultiCompiler, MultiStats, Stats, Watching } from "..";
+type Logger = ReturnType<Compiler["getInfrastructureLogger"]>;
+type MultiWatching = MultiCompiler["watch"];
+type BasicServer = import("net").Server | import("tls").Server;
+type ReadStream = typeof import("fs").ReadStream;
+type IncomingMessage = typeof import("http").IncomingMessage;
+type ServerResponse = typeof import("http").ServerResponse;
+type ServerOptions = import("https").ServerOptions & {
+    spdy?: {
+        plain?: boolean | undefined;
+        ssl?: boolean | undefined;
+        "x-forwarded-for"?: string | undefined;
+        protocol?: string | undefined;
+        protocols?: string[] | undefined;
+    };
+};
+type ResponseData = {
+    data: Buffer | ReadStream;
+    byteLength: number;
+};
+type ModifyResponseData<RequestInternal extends IncomingMessage = IncomingMessage, ResponseInternal extends ServerResponse = ServerResponse> = (req: RequestInternal, res: ResponseInternal, data: Buffer | ReadStream, byteLength: number) => ResponseData;
+type Headers = Array<{
+    key: string;
+    value: string;
+}> | Record<string, string | string[]>;
+type OutputFileSystem = import("..").OutputFileSystem & {
+    createReadStream?: typeof import("fs").createReadStream;
+    statSync: import("fs").StatSyncFn;
+    readFileSync: typeof import("fs").readFileSync;
+};
+type RspackConfiguration = import("..").Configuration;
+type Port = number | string | "auto";
+type HistoryContext = {
+    readonly match: RegExpMatchArray;
+    readonly parsedUrl: import("url").Url;
+    readonly request: any;
+};
+type RewriteTo = (context: HistoryContext) => string;
+type Rewrite = {
+    readonly from: RegExp;
+    readonly to: string | RegExp | RewriteTo;
+};
+type HistoryApiFallbackOptions = {
+    readonly disableDotRule?: true | undefined;
+    readonly htmlAcceptHeaders?: readonly string[] | undefined;
+    readonly index?: string | undefined;
+    readonly logger?: typeof console.log | undefined;
+    readonly rewrites?: readonly Rewrite[] | undefined;
+    readonly verbose?: boolean | undefined;
+};
+type DevMiddlewareOptions<RequestInternal extends IncomingMessage = IncomingMessage, ResponseInternal extends ServerResponse = ServerResponse> = {
+    mimeTypes?: {
+        [key: string]: string;
+    } | undefined;
+    mimeTypeDefault?: string | undefined;
+    writeToDisk?: boolean | ((targetPath: string) => boolean) | undefined;
+    methods?: string[] | undefined;
+    headers?: any;
+    publicPath?: NonNullable<RspackConfiguration["output"]>["publicPath"];
+    stats?: RspackConfiguration["stats"];
+    serverSideRender?: boolean | undefined;
+    outputFileSystem?: OutputFileSystem | undefined;
+    index?: string | boolean | undefined;
+    modifyResponseData?: ModifyResponseData<RequestInternal, ResponseInternal> | undefined;
+    etag?: "strong" | "weak" | undefined;
+    lastModified?: boolean | undefined;
+    cacheControl?: string | number | boolean | {
+        maxAge?: number;
+        immutable?: boolean;
+    } | undefined;
+    cacheImmutable?: boolean | undefined;
+};
+type BasicApplication = any;
+type BonjourServer = any;
+type ChokidarWatchOptions = {
+    [key: string]: any;
+};
+type ServeIndexOptions = {
+    [key: string]: any;
+};
+type ServeStaticOptions = {
+    [key: string]: any;
+};
+type HttpProxyMiddlewareOptionsFilter = any;
+type Request = IncomingMessage;
+type Response = ServerResponse;
+type WatchFiles = {
+    paths: string | string[];
+    options?: (ChokidarWatchOptions & {
+        aggregateTimeout?: number;
+        ignored?: ChokidarWatchOptions["ignored"];
+        poll?: number | boolean;
+    }) | undefined;
+};
+type Static = {
+    directory?: string | undefined;
+    publicPath?: string | string[] | undefined;
+    serveIndex?: boolean | ServeIndexOptions | undefined;
+    staticOptions?: ServeStaticOptions | undefined;
+    watch?: boolean | (ChokidarWatchOptions & {
+        aggregateTimeout?: number;
+        ignored?: ChokidarWatchOptions["ignored"];
+        poll?: number | boolean;
+    }) | undefined;
+};
+type ServerType<A extends BasicApplication = BasicApplication, S extends BasicServer = import("http").Server<IncomingMessage, ServerResponse>> = "http" | "https" | "spdy" | "http2" | string | ((arg0: ServerOptions, arg1: A) => S);
+type ServerConfiguration<A extends BasicApplication = BasicApplication, S extends BasicServer = import("http").Server<IncomingMessage, ServerResponse>> = {
+    type?: ServerType<A, S> | undefined;
+    options?: ServerOptions | undefined;
+};
+type WebSocketServerConfiguration = {
+    type?: string | Function | undefined;
+    options?: Record<string, any> | undefined;
+};
+type NextFunction = (err?: any) => void;
+type ProxyConfigArrayItem = {
+    path?: HttpProxyMiddlewareOptionsFilter | undefined;
+    context?: HttpProxyMiddlewareOptionsFilter | undefined;
+} & {
+    bypass?: ByPass;
+} & {
+    [key: string]: any;
+};
+type ByPass = (req: Request, res: Response, proxyConfig: ProxyConfigArrayItem) => any;
+type ProxyConfigArray = (ProxyConfigArrayItem | ((req?: Request | undefined, res?: Response | undefined, next?: NextFunction | undefined) => ProxyConfigArrayItem))[];
+type Callback = (stats?: Stats | MultiStats | undefined) => any;
+type DevMiddlewareContext<RequestInternal extends IncomingMessage = IncomingMessage, ResponseInternal extends ServerResponse = ServerResponse> = {
+    state: boolean;
+    stats: Stats | MultiStats | undefined;
+    callbacks: Callback[];
+    options: any;
+    compiler: Compiler | MultiCompiler;
+    watching: Watching | MultiWatching | undefined;
+    logger: Logger;
+    outputFileSystem: OutputFileSystem;
+};
+type Server = any;
+type MiddlewareHandler = any;
+type MiddlewareObject = {
+    name?: string;
+    path?: string;
+    middleware: MiddlewareHandler;
+};
+export type Middleware = MiddlewareObject | MiddlewareHandler;
+type OpenApp = {
+    name?: string | undefined;
+    arguments?: string[] | undefined;
+};
+type Open = {
+    app?: string | string[] | OpenApp | undefined;
+    target?: string | string[] | undefined;
+};
+type OverlayMessageOptions = boolean | ((error: Error) => void);
+type WebSocketURL = {
+    hostname?: string | undefined;
+    password?: string | undefined;
+    pathname?: string | undefined;
+    port?: string | number | undefined;
+    protocol?: string | undefined;
+    username?: string | undefined;
+};
+type ClientConfiguration = {
+    logging?: "none" | "error" | "warn" | "info" | "log" | "verbose" | undefined;
+    overlay?: boolean | {
+        warnings?: OverlayMessageOptions;
+        errors?: OverlayMessageOptions;
+        runtimeErrors?: OverlayMessageOptions;
+    } | undefined;
+    progress?: boolean | undefined;
+    reconnect?: number | boolean | undefined;
+    webSocketTransport?: string | undefined;
+    webSocketURL?: string | WebSocketURL | undefined;
+};
+export type DevServerOptions<A extends BasicApplication = BasicApplication, S extends BasicServer = import("http").Server<IncomingMessage, ServerResponse>> = {
+    ipc?: string | boolean | undefined;
+    host?: string | undefined;
+    port?: Port | undefined;
+    hot?: boolean | "only" | undefined;
+    liveReload?: boolean | undefined;
+    devMiddleware?: DevMiddlewareOptions | undefined;
+    compress?: boolean | undefined;
+    allowedHosts?: string | string[] | undefined;
+    historyApiFallback?: boolean | HistoryApiFallbackOptions | undefined;
+    bonjour?: boolean | Record<string, never> | BonjourServer | undefined;
+    watchFiles?: string | string[] | WatchFiles | (string | WatchFiles)[] | undefined;
+    static?: string | boolean | Static | (string | Static)[] | undefined;
+    server?: ServerType<A, S> | ServerConfiguration<A, S> | undefined;
+    app?: (() => Promise<A>) | undefined;
+    webSocketServer?: string | boolean | WebSocketServerConfiguration | undefined;
+    proxy?: ProxyConfigArray | undefined;
+    open?: string | boolean | Open | (string | Open)[] | undefined;
+    setupExitSignals?: boolean | undefined;
+    client?: boolean | ClientConfiguration | undefined;
+    headers?: Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response> | undefined) => Headers) | undefined;
+    onListening?: ((devServer: Server) => void) | undefined;
+    setupMiddlewares?: ((middlewares: Middleware[], devServer: Server) => Middleware[]) | undefined;
+};
+export {};

package/dist/config/types.d.ts

@@ -1,5 +1,4 @@
 import type { AssetInfo, RawFuncUseCtx } from "@rspack/binding";
-import type * as webpackDevServer from "webpack-dev-server";
 import type { ChunkGraph } from "../ChunkGraph";
 import type { Compilation, PathData } from "../Compilation";
 import type { Compiler } from "../Compiler";
@@ -8,6 +7,7 @@ import type ModuleGraph from "../ModuleGraph";
 import type { HttpUriPluginOptions } from "../builtin-plugin/HttpUriPlugin";
 import type { Chunk } from "../exports";
 import type { ResolveCallback } from "./adapterRuleUse";
+import type { DevServerOptions } from "./devServer";
 export type FilenameTemplate = string;
 export type Filename = FilenameTemplate | ((pathData: PathData, assetInfo?: AssetInfo) => string);
 /** Name of the configuration. Used when loading multiple configurations. */
@@ -1812,11 +1812,13 @@ export type RspackFutureOptions = {
  */
 export type LazyCompilationOptions = {
     /**
-     * Enable lazy compilation for imports.
+     * Enable lazy compilation for dynamic imports.
+     * @default true
      */
     imports?: boolean;
     /**
      * Enable lazy compilation for entries.
+     * @default true
      */
     entries?: boolean;
     /**
@@ -1824,13 +1826,23 @@ export type LazyCompilationOptions = {
      */
     test?: RegExp | ((module: Module) => boolean);
     /**
-     * The runtime code path for client
+     * The path to a custom runtime code that overrides the default lazy
+     * compilation client. If you want to customize the logic of the client
+     * runtime, you can specify it through this option.
      */
     client?: string;
     /**
-     * The server url
+     * Tells the client the server URL that needs to be requested.
+     * By default it is empty, in a browser environment it will find
+     * the server path where the page is located, but in a node
+     * environment you need to explicitly specify a specific path.
      */
     serverUrl?: string;
+    /**
+     * Customize the prefix used for lazy compilation endpoint.
+     * @default "/lazy-compilation-using-"
+     */
+    prefix?: string;
 };
 /**
  * Options for incremental builds.
@@ -2007,7 +2019,7 @@ export type WatchOptions = {
 /**
  * Options for devServer, it based on `webpack-dev-server@5`
  * */
-export interface DevServer extends webpackDevServer.Configuration {
+export interface DevServer extends DevServerOptions {
 }
 /**
  * An array of either regular expressions or functions that determine if a warning should be ignored.

package/dist/config/utils.d.ts

@@ -1,10 +1,10 @@
-import { type IssueData, type ParseReturnType, ZodType, type ZodTypeDef, z } from "../../compiled/zod";
+import z, { type IssueData, type ParseReturnType, ZodType, type ZodTypeDef } from "../../compiled/zod";
 import type { RspackOptions } from "./types";
 export type ZodCrossFieldsOptions = ZodTypeDef & {
     patterns: Array<{
-        test: (root: RspackOptions) => boolean;
+        test: (root: RspackOptions, input: z.ParseInput) => boolean;
         type: ZodType;
-        issue?: (res: ParseReturnType<any>) => Array<IssueData>;
+        issue?: (res: ParseReturnType<any>, root: RspackOptions, input: z.ParseInput) => Array<IssueData>;
     }>;
     default: ZodType;
 };