[api-extractor] bundledPackages uses a source declaration name instead of its exported alias
Summary
When an aliased API export from a package listed in bundledPackages is referenced, API Extractor uses the original source declaration name when referencing that API from the consuming package. The original name is not part of the dependency's public API, so the generated API model and report contain an incorrect reference and an ae-forgotten-export warning. The incorrect name is also used in the generated declaration rollup.
Repro steps
The minimal reproduction is available at:
https://github.com/Josmithr/api-extractor-playground/tree/bundledPackages-reexport-aliased
-
Clone the reproduction branch.
-
From the repository root, install dependencies and build package-b with its dependency:
yarn install --frozen-lockfile
yarn lerna run build --scope package-b --include-dependencies
-
Inspect packages/package-b/api-reports/package-b.api.md and packages/package-b/dist/package-b-public.d.ts.
In package-a, FooInternal is exported from the package entry point as FooExternal:
// package-a/src/FooInternal.ts
export type FooInternal = string;
// package-a/src/index.ts
export { FooInternal as FooExternal } from './FooInternal.js';
package-b lists package-a in bundledPackages and references the public name FooExternal:
import type { FooExternal } from 'package-a';
/** @public */
export type Baz = FooExternal;
Expected result:
The API report should preserve the name exported by package-a:
export type Baz = FooExternal;
Actual result:
The API report uses the private source declaration name and reports it as a forgotten export:
// Warning: (ae-forgotten-export) The symbol "FooInternal" needs to be exported by the entry point index.d.ts
//
// @public
export type Baz = FooInternal;
The public declaration rollup similarly contains:
export declare type Baz = FooInternal;
declare type FooInternal = string;
Details
This appears to occur while API Extractor follows the FooExternal re-export into the bundled package. It resolves the underlying declaration correctly, but uses that declaration's local name (FooInternal) instead of the name exported from the dependency's entry point (FooExternal) when generating references in package-b.
Explicitly re-exporting FooExternal from package-b avoids the issue:
export type { FooExternal } from 'package-a';
export type { Baz } from './Baz.js';
With this re-export, the API report and declaration rollup both use FooExternal, and the ae-forgotten-export warning disappears. This suggests the incorrect name is used specifically when the bundled API is referenced by an exported declaration but is not itself exported from the consumer's entry point.
Standard questions
Please answer these questions to help us investigate your issue more quickly:
| Question |
Answer |
@microsoft/api-extractor version? |
7.58.12 |
| Operating system? |
Linux x64 (Ubuntu 24.04) |
| API Extractor scenario? |
Reporting (.api.md) and rollups (.d.ts) |
| Would you consider contributing a PR? |
Possibly, with maintainer guidance |
| TypeScript compiler version? |
5.9.3 |
Node.js version (node -v)? |
v24.14.0 |
[api-extractor] bundledPackages uses a source declaration name instead of its exported alias
Summary
When an aliased API export from a package listed in
bundledPackagesis referenced, API Extractor uses the original source declaration name when referencing that API from the consuming package. The original name is not part of the dependency's public API, so the generated API model and report contain an incorrect reference and anae-forgotten-exportwarning. The incorrect name is also used in the generated declaration rollup.Repro steps
The minimal reproduction is available at:
https://github.com/Josmithr/api-extractor-playground/tree/bundledPackages-reexport-aliased
Clone the reproduction branch.
From the repository root, install dependencies and build
package-bwith its dependency:Inspect
packages/package-b/api-reports/package-b.api.mdandpackages/package-b/dist/package-b-public.d.ts.In
package-a,FooInternalis exported from the package entry point asFooExternal:package-blistspackage-ainbundledPackagesand references the public nameFooExternal:Expected result:
The API report should preserve the name exported by
package-a:Actual result:
The API report uses the private source declaration name and reports it as a forgotten export:
The public declaration rollup similarly contains:
Details
This appears to occur while API Extractor follows the
FooExternalre-export into the bundled package. It resolves the underlying declaration correctly, but uses that declaration's local name (FooInternal) instead of the name exported from the dependency's entry point (FooExternal) when generating references inpackage-b.Explicitly re-exporting
FooExternalfrompackage-bavoids the issue:With this re-export, the API report and declaration rollup both use
FooExternal, and theae-forgotten-exportwarning disappears. This suggests the incorrect name is used specifically when the bundled API is referenced by an exported declaration but is not itself exported from the consumer's entry point.Standard questions
Please answer these questions to help us investigate your issue more quickly:
@microsoft/api-extractorversion?.api.md) and rollups (.d.ts)node -v)?