@rsbuild/core 1.3.18 → 1.3.20

package/dist-types/types/config.d.ts

@@ -8,12 +8,13 @@ import type { Options as HttpProxyOptions, Filter as ProxyFilter } from '../../c
 import type RspackChain from '../../compiled/rspack-chain';
 import type { FileDescriptor } from '../../compiled/rspack-manifest-plugin';
 import type { BundleAnalyzerPlugin } from '../../compiled/webpack-bundle-analyzer/index.js';
+import type { RsbuildDevServer } from '../server/devServer';
 import type { ModifyBundlerChainUtils, ModifyChainUtils, Routes } from './hooks';
 import type { ModifyWebpackChainUtils, ModifyWebpackConfigUtils, RsbuildPlugins } from './plugin';
 import type { RsbuildEntry, RsbuildMode, RsbuildTarget } from './rsbuild';
 import type { BundlerPluginInstance, Rspack, RspackRule } from './rspack';
 import type { CSSExtractOptions, CSSLoaderModulesOptions, CSSLoaderOptions, HtmlRspackPlugin, PostCSSLoaderOptions, PostCSSPlugin, StyleLoaderOptions, WebpackConfig } from './thirdParty';
-import type { ConfigChain, ConfigChainAsyncWithContext, ConfigChainMergeContext, ConfigChainWithContext, DeepReadonly, MaybePromise, OneOrMany } from './utils';
+import type { ConfigChain, ConfigChainMergeContext, ConfigChainWithContext, DeepReadonly, MaybePromise, OneOrMany } from './utils';
 export type ToolsSwcConfig = ConfigChain<SwcLoaderOptions>;
 export type ToolsBundlerChainConfig = OneOrMany<(chain: RspackChain, utils: ModifyBundlerChainUtils) => MaybePromise<void>>;
 export type ToolsPostCSSLoaderConfig = ConfigChainWithContext<PostCSSLoaderOptions, {
@@ -25,16 +26,62 @@ export type ToolsHtmlPluginConfig = ConfigChainWithContext<HtmlRspackPlugin.Opti
     entryName: string;
     entryValue: (string | string[] | Rspack.EntryDescription)[];
 }>;
-export type WebpackMerge = <Configuration extends object>(firstConfiguration: Configuration | Configuration[], ...configurations: Configuration[]) => Configuration;
+export type RspackMerge = (firstConfiguration: Rspack.Configuration | Rspack.Configuration[], ...configurations: Rspack.Configuration[]) => Rspack.Configuration;
 export type ModifyRspackConfigUtils = ModifyChainUtils & {
     addRules: (rules: RspackRule | RspackRule[]) => void;
     appendRules: (rules: RspackRule | RspackRule[]) => void;
     prependPlugins: (plugins: BundlerPluginInstance | BundlerPluginInstance[]) => void;
     appendPlugins: (plugins: BundlerPluginInstance | BundlerPluginInstance[]) => void;
     removePlugin: (pluginName: string) => void;
-    mergeConfig: WebpackMerge;
+    mergeConfig: RspackMerge;
 };
-export type ToolsRspackConfig = ConfigChainAsyncWithContext<Rspack.Configuration, ModifyRspackConfigUtils>;
+/**
+ * Narrow the type of Rspack.Configuration to make it easier
+ * to use `tools.rspack` function. These properties are set
+ * by Rsbuild by default so they are non-nullable.
+ *
+ * - With `Rspack.Configuration`, the `plugins` property is nullable:
+ *
+ * ```js
+ * tools: {
+ *   rspack(config) {
+ *     if (!config.plugins) {
+ *       config.plugins = [];
+ *     }
+ *     config.plugins.push(new SomePlugin());
+ *   }
+ * }
+ * ```
+ *
+ * - With `NarrowedRspackConfig`, the `plugins` property is non-nullable:
+ *
+ * ```js
+ * tools: {
+ *   rspack(config) {
+ *     config.plugins.push(new SomePlugin());
+ *   }
+ * }
+ * ```
+ */
+export type NarrowedRspackConfig = Omit<Rspack.Configuration, 'plugins' | 'module' | 'resolve' | 'output'> & {
+    /**
+     * Plugins to use during compilation.
+     */
+    plugins: NonNullable<Rspack.Configuration['plugins']>;
+    /**
+     * Options for module configuration.
+     */
+    module: NonNullable<Rspack.Configuration['module']>;
+    /**
+     * Options for resolving modules.
+     */
+    resolve: NonNullable<Rspack.Configuration['resolve']>;
+    /**
+     * Configuration for the output of the compilation.
+     */
+    output: NonNullable<Rspack.Configuration['output']>;
+};
+export type ToolsRspackConfig = OneOrMany<Rspack.Configuration | ((config: NarrowedRspackConfig, ctx: ModifyRspackConfigUtils) => MaybePromise<Rspack.Configuration | void>)>;
 export type ToolsWebpackConfig = ConfigChainWithContext<WebpackConfig, ModifyWebpackConfigUtils>;
 export type ToolsWebpackChainConfig = OneOrMany<(chain: RspackChain, utils: ModifyWebpackChainUtils) => void>;
 export interface ToolsConfig {
@@ -1209,10 +1256,7 @@ export type EnvironmentAPI = {
         getTransformedHtml: (entryName: string) => Promise<string>;
     };
 };
-export type SetupMiddlewaresServer = {
-    sockWrite: (type: string, data?: string | boolean | Record<string, any>) => void;
-    environments: EnvironmentAPI;
-};
+export type SetupMiddlewaresServer = Pick<RsbuildDevServer, 'sockWrite' | 'environments'>;
 export type SetupMiddlewaresFn = (middlewares: {
     unshift: (...handlers: RequestHandler[]) => void;
     push: (...handlers: RequestHandler[]) => void;

package/dist-types/types/plugin.d.ts

@@ -2,7 +2,7 @@
 import type { RuleSetRule, Configuration as WebpackConfig, WebpackPluginInstance } from 'webpack';
 import type RspackChain from '../../compiled/rspack-chain';
 import type { ChainIdentifier } from '../configChain';
-import type { ModifyRspackConfigUtils, NormalizedConfig, NormalizedEnvironmentConfig, RsbuildConfig, WebpackMerge } from './config';
+import type { ModifyRspackConfigUtils, NarrowedRspackConfig, NormalizedConfig, NormalizedEnvironmentConfig, RsbuildConfig, RspackMerge } from './config';
 import type { RsbuildContext } from './context';
 import type { EnvironmentContext, ModifyBundlerChainFn, ModifyChainUtils, ModifyEnvironmentConfigFn, ModifyHTMLFn, ModifyHTMLTagsFn, ModifyRsbuildConfigFn, OnAfterBuildFn, OnAfterCreateCompilerFn, OnAfterEnvironmentCompileFn, OnAfterStartDevServerFn, OnAfterStartProdServerFn, OnBeforeBuildFn, OnBeforeCreateCompilerFn, OnBeforeEnvironmentCompileFn, OnBeforeStartDevServerFn, OnBeforeStartProdServerFn, OnCloseBuildFn, OnCloseDevServerFn, OnDevCompileDoneFn, OnExitFn } from './hooks';
 import type { RsbuildInstance, RsbuildTarget } from './rsbuild';
@@ -92,7 +92,7 @@ export type AsyncHook<Callback extends (...args: any[]) => T, T = any> = {
      */
     callBatch: (...args: Parameters<Callback>) => Promise<Awaited<ReturnType<Callback>>[]>;
 };
-export type ModifyRspackConfigFn = (config: Rspack.Configuration, utils: ModifyRspackConfigUtils) => MaybePromise<Rspack.Configuration | void>;
+export type ModifyRspackConfigFn = (config: NarrowedRspackConfig, utils: ModifyRspackConfigUtils) => MaybePromise<Rspack.Configuration | void>;
 export type ModifyWebpackChainUtils = ModifyChainUtils & {
     /** @ts-ignore `webpack` type only exists when `@rsbuild/webpack` is installed */
     webpack: typeof import('webpack');
@@ -112,7 +112,7 @@ export type ModifyWebpackConfigUtils = ModifyWebpackChainUtils & {
     prependPlugins: (plugins: WebpackPluginInstance | WebpackPluginInstance[]) => void;
     appendPlugins: (plugins: WebpackPluginInstance | WebpackPluginInstance[]) => void;
     removePlugin: (pluginName: string) => void;
-    mergeConfig: WebpackMerge;
+    mergeConfig: RspackMerge;
 };
 export type ModifyWebpackChainFn = (chain: RspackChain, utils: ModifyWebpackChainUtils) => Promise<void> | void;
 export type ModifyWebpackConfigFn = (config: WebpackConfig, utils: ModifyWebpackConfigUtils) => Promise<WebpackConfig | void> | WebpackConfig | void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsbuild/core",
-  "version": "1.3.18",
+  "version": "1.3.20",
   "description": "The Rspack-based build tool.",
   "homepage": "https://rsbuild.dev",
   "bugs": {
@@ -46,17 +46,17 @@
     "types.d.ts"
   ],
   "dependencies": {
-    "@rspack/core": "1.3.9",
+    "@rspack/core": "1.3.10",
     "@rspack/lite-tapable": "~1.0.1",
     "@swc/helpers": "^0.5.17",
     "core-js": "~3.42.0",
     "jiti": "^2.4.2"
   },
   "devDependencies": {
-    "@rslib/core": "0.6.8",
+    "@rslib/core": "0.7.0",
     "@types/connect": "3.4.38",
-    "@types/cors": "^2.8.17",
-    "@types/node": "^22.15.3",
+    "@types/cors": "^2.8.18",
+    "@types/node": "^22.15.17",
     "@types/on-finished": "2.3.4",
     "@types/webpack-bundle-analyzer": "4.7.0",
     "@types/ws": "^8.18.1",
@@ -90,7 +90,7 @@
     "style-loader": "3.3.4",
     "tinyglobby": "^0.2.13",
     "typescript": "^5.8.3",
-    "webpack": "^5.98.0",
+    "webpack": "^5.99.8",
     "webpack-bundle-analyzer": "^4.10.2",
     "webpack-merge": "6.0.1",
     "ws": "^8.18.2"