rsbuild-plugin-dts 0.9.0 → 0.9.1

package/README.md

@@ -1,5 +1,5 @@
 <picture>
-  <img alt="Rslib Banner" src="https://assets.rspack.dev/rslib/rslib-banner.png">
+  <img alt="Rslib Banner" src="https://assets.rspack.rs/rslib/rslib-banner.png">
 </picture>
 
 # rsbuild-plugin-dts
@@ -8,7 +8,7 @@ An [Rsbuild plugin](https://www.npmjs.com/package/rsbuild-plugin-dts) to emit de
 
 ## Using in Rslib
 
-Read [Declaration files](https://lib.rsbuild.dev/guide/advanced/dts) and [lib.dts](https://lib.rsbuild.dev/config/lib/dts) for more details.
+Read [Declaration files](https://rslib.rs/guide/advanced/dts) and [lib.dts](https://rslib.rs/config/lib/dts) for more details.
 
 ## Using in Rsbuild
 
@@ -38,7 +38,7 @@ export default {
 
 Whether to bundle the declaration files.
 
-If you want to [bundle declaration files](https://lib.rsbuild.dev/guide/advanced/dts#bundle-declaration-files) files, you should:
+If you want to [bundle declaration files](https://rslib.rs/guide/advanced/dts#bundle-declaration-files) files, you should:
 
 1. Install `@microsoft/api-extractor` as a development dependency, which is the underlying tool used for bundling declaration files.
 
@@ -54,6 +54,33 @@ pluginDts({
 });
 ```
 
+#### bundle.bundledPackages
+
+- **Type:** `string[]`
+
+Specifies the dependencies whose declaration files should be bundled. This configuration is passed to the [bundledPackages](https://api-extractor.com/pages/configs/api-extractor_json/#bundledpackages) option of `@microsoft/api-extractor`.
+
+By default, `rsbuild-plugin-dts` determines externalized dependencies based on the following configurations.
+
+- [autoExternal](#autoexternal) configuration
+- [output.externals](https://rsbuild.rs/config/output/externals) configuration
+
+Direct dependencies (declared in `package.json`) that are not externalized will be automatically added to `bundledPackages`, and their declaration files will be bundled into the final output.
+
+When the default behavior does not meet the requirements, you can explicitly specify the dependencies whose declaration files need to be bundled through `bundle.bundledPackages`. After setting this configuration, the above default behavior will be completely overwritten.
+
+This is typically used for bundling transitive dependencies (dependencies of direct dependencies). For example, if the project directly depends on `foo`, and `foo` depends on `bar`, you can bundle both `foo` and `bar`'s declaration files as follows:
+
+```js
+pluginDts({
+  bundle: {
+    bundledPackages: ['foo', 'bar'],
+  },
+});
+```
+
+> `bundledPackages` can be specified with the [minimatch](https://www.npmjs.com/package/minimatch) syntax, but will only match the declared direct dependencies in `package.json`.
+
 ### distPath
 
 - **Type:** `string`
@@ -62,7 +89,7 @@ The output directory of declaration files. The default value follows the priorit
 
 1. The `distPath` value of the plugin options.
 2. The `declarationDir` value in the `tsconfig.json` file.
-3. The [output.distPath.root](https://rsbuild.dev/config/output/dist-path) value of Rsbuild configuration.
+3. The [output.distPath.root](https://rsbuild.rs/config/output/dist-path) value of Rsbuild configuration.
 
 ```js
 pluginDts({

package/dist/apiExtractor.js

@@ -8,7 +8,7 @@ async function bundleDts(options) {
     try {
         apiExtractor = await import("@microsoft/api-extractor");
     } catch  {
-        throw new Error(`${__WEBPACK_EXTERNAL_MODULE_picocolors__["default"].cyan('@microsoft/api-extractor')} is required when ${__WEBPACK_EXTERNAL_MODULE_picocolors__["default"].cyan('dts.bundle')} is set to ${__WEBPACK_EXTERNAL_MODULE_picocolors__["default"].cyan('true')}, please make sure it is installed. You could check https://lib.rsbuild.dev/guide/advanced/dts#how-to-generate-declaration-files-in-rslib for more details.`);
+        throw new Error(`${__WEBPACK_EXTERNAL_MODULE_picocolors__["default"].cyan('@microsoft/api-extractor')} is required when ${__WEBPACK_EXTERNAL_MODULE_picocolors__["default"].cyan('dts.bundle')} is set to ${__WEBPACK_EXTERNAL_MODULE_picocolors__["default"].cyan('true')}, please make sure it is installed. You could check https://rslib.rs/guide/advanced/dts#how-to-generate-declaration-files-in-rslib for more details.`);
     }
     const { Extractor, ExtractorConfig, ExtractorLogLevel } = apiExtractor;
     const { name, cwd, distPath, dtsExtension, banner, footer, dtsEntry, tsconfigPath = 'tsconfig.json', bundledPackages = [] } = options;

package/dist/dts.d.ts

@@ -1,7 +1,8 @@
 import type { DtsGenOptions } from './index';
 export declare const calcBundledPackages: (options: {
-    autoExternal: DtsGenOptions["autoExternal"];
     cwd: string;
+    autoExternal: DtsGenOptions["autoExternal"];
     userExternals?: DtsGenOptions["userExternals"];
+    overrideBundledPackages?: string[];
 }) => string[];
 export declare function generateDts(data: DtsGenOptions): Promise<void>;

package/dist/dts.js

@@ -6,7 +6,8 @@ import * as __WEBPACK_EXTERNAL_MODULE__tsc_js_1050029c__ from "./tsc.js";
 import * as __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__ from "./utils.js";
 const isObject = (obj)=>'[object Object]' === Object.prototype.toString.call(obj);
 const calcBundledPackages = (options)=>{
-    const { autoExternal, cwd, userExternals } = options;
+    const { cwd, autoExternal, userExternals, overrideBundledPackages } = options;
+    if (overrideBundledPackages) return overrideBundledPackages;
     let pkgJson;
     try {
         const content = __WEBPACK_EXTERNAL_MODULE_node_fs_5ea92f0c__["default"].readFileSync((0, __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__.join)(cwd, 'package.json'), 'utf-8');
@@ -52,7 +53,7 @@ const calcBundledPackages = (options)=>{
     return Array.from(new Set(bundledPackages));
 };
 async function generateDts(data) {
-    const { bundle, dtsEntry, dtsEmitPath, tsconfigPath, tsConfigResult, name, cwd, build, isWatch, dtsExtension = '.d.ts', autoExternal = true, userExternals, banner, footer, redirect = {
+    const { bundle, dtsEntry, dtsEmitPath, tsconfigPath, tsConfigResult, name, cwd, build, isWatch, dtsExtension = '.d.ts', autoExternal = true, userExternals, apiExtractorOptions, banner, footer, redirect = {
         path: true,
         extension: false
     } } = data;
@@ -93,9 +94,10 @@ async function generateDts(data) {
                 banner,
                 footer,
                 bundledPackages: calcBundledPackages({
-                    autoExternal,
                     cwd,
-                    userExternals
+                    autoExternal,
+                    userExternals,
+                    overrideBundledPackages: apiExtractorOptions?.bundledPackages
                 })
             });
         }

package/dist/index.d.ts

@@ -4,8 +4,11 @@ export type DtsRedirect = {
     path?: boolean;
     extension?: boolean;
 };
+export type ApiExtractorOptions = {
+    bundledPackages?: string[];
+};
 export type PluginDtsOptions = {
-    bundle?: boolean;
+    bundle?: boolean | ApiExtractorOptions;
     distPath?: string;
     build?: boolean;
     abortOnError?: boolean;
@@ -24,7 +27,8 @@ export type DtsEntry = {
     name?: string;
     path?: string;
 };
-export type DtsGenOptions = PluginDtsOptions & {
+export type DtsGenOptions = Omit<PluginDtsOptions, 'bundle'> & {
+    bundle: boolean;
     name: string;
     cwd: string;
     isWatch: boolean;
@@ -34,6 +38,7 @@ export type DtsGenOptions = PluginDtsOptions & {
     tsconfigPath: string;
     tsConfigResult: ts.ParsedCommandLine;
     userExternals?: NonNullable<RsbuildConfig['output']>['externals'];
+    apiExtractorOptions?: ApiExtractorOptions;
 };
 export declare const PLUGIN_DTS_NAME = "rsbuild:dts";
 export declare const pluginDts: (options?: PluginDtsOptions) => RsbuildPlugin;

package/dist/index.js

@@ -11,7 +11,11 @@ const PLUGIN_DTS_NAME = 'rsbuild:dts';
 const pluginDts = (options = {})=>({
         name: PLUGIN_DTS_NAME,
         setup (api) {
-            options.bundle = options.bundle ?? false;
+            let apiExtractorOptions = {};
+            if (options.bundle && 'object' == typeof options.bundle) apiExtractorOptions = {
+                ...options.bundle
+            };
+            const bundle = !!options.bundle;
             options.abortOnError = options.abortOnError ?? true;
             options.build = options.build ?? false;
             options.redirect = options.redirect ?? {};
@@ -23,7 +27,7 @@ const pluginDts = (options = {})=>({
             api.onBeforeEnvironmentCompile(async ({ isWatch, isFirstCompile, environment })=>{
                 if (!isFirstCompile) return;
                 const { config } = environment;
-                const dtsEntry = (0, __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.processSourceEntry)(options.bundle, config.source?.entry);
+                const dtsEntry = (0, __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.processSourceEntry)(bundle, config.source?.entry);
                 const cwd = api.context.rootPath;
                 const tsconfigPath = __WEBPACK_EXTERNAL_MODULE_typescript__["default"].findConfigFile(cwd, __WEBPACK_EXTERNAL_MODULE_typescript__["default"].sys.fileExists, config.source.tsconfigPath);
                 if (!tsconfigPath) {
@@ -37,7 +41,7 @@ const pluginDts = (options = {})=>({
                 (0, __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.warnIfOutside)(cwd, declarationDir, 'declarationDir');
                 (0, __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.warnIfOutside)(cwd, outDir, 'outDir');
                 if (false !== config.output.cleanDistPath) await (0, __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.cleanDtsFiles)(dtsEmitPath);
-                if (options.bundle) await (0, __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.clearTempDeclarationDir)(cwd);
+                if (bundle) await (0, __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.clearTempDeclarationDir)(cwd);
                 if (composite || incremental || options.build) await (0, __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.cleanTsBuildInfoFile)(tsconfigPath, rawCompilerOptions);
                 const jsExtension = (0, __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__.extname)(src_filename);
                 const childProcess = (0, __WEBPACK_EXTERNAL_MODULE_node_child_process_27f17141__.fork)((0, __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__.join)(src_dirname, `./dts${jsExtension}`), [], {
@@ -46,9 +50,11 @@ const pluginDts = (options = {})=>({
                 childProcesses.push(childProcess);
                 const dtsGenOptions = {
                     ...options,
+                    bundle,
                     dtsEntry,
                     dtsEmitPath,
                     userExternals: config.output.externals,
+                    apiExtractorOptions,
                     tsconfigPath,
                     tsConfigResult,
                     name: environment.name,

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "rsbuild-plugin-dts",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Rsbuild plugin that supports emitting declaration files for TypeScript.",
-  "homepage": "https://lib.rsbuild.dev",
+  "homepage": "https://rslib.rs",
   "bugs": {
     "url": "https://github.com/web-infra-dev/rslib/issues"
   },
@@ -33,9 +33,9 @@
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.52.8",
-    "@rsbuild/core": "1.3.21",
+    "@rsbuild/core": "~1.3.21",
     "rsbuild-plugin-publint": "^0.3.2",
-    "rslib": "npm:@rslib/core@0.8.0",
+    "rslib": "npm:@rslib/core@0.9.0",
     "typescript": "^5.8.3",
     "@rslib/tsconfig": "0.0.1"
   },