fix(hook): fix declarationPaths type signature

Author: wessberg

README.md

@@ -468,12 +468,15 @@ Type: `(stats: DeclarationStats) => DeclarationStats|undefined`
 
 The `declarationStats` hook can be used to get relevant stats produced while bundling declarations.
 The hook calls the given callback with a stats object as the first argument.
-The stats object has the following interface:
+The stats object has the following type information:
 
 ```typescript
-interface DeclarationStats {
-// A Record from chunk file names to their external type dependencies
-externalTypes: Record<string, ExternalType[]>;
+// A Record from chunk file names to their stats
+type DeclarationStats = Record<string, DeclarationChunkStats>;
+
+interface DeclarationChunkStats {
+// An array of the external type dependencies for a declaration chunk
+externalTypes: ExternalType[];
 }
 
 interface ExternalType {
@@ -484,17 +487,17 @@ interface ExternalType {
 }
 ```
 
-##### The `externalTypes` property
+##### The `externalTypes` property for `DeclarationChunkStats`
 
-The `externalTypes` property of the stats object can be useful, for example, if you want to get a hook into which external type dependencies that remain
+The `externalTypes` property of declaration chunk stats objects can be useful, for example, if you want to get a hook into which external type dependencies that remain
 after bundling and tree-shaking and that you should declare as `dependencies` of your library.
 
 Here's an example of how you might use the hook:
 
 ```typescript
 ts({
 hook: {
-declarationStats: declarationStats => console.log(declarationStats.externalTypes)
+declarationStats: declarationStats => console.log(declarationStats)
 }
 });
 ```
@@ -503,13 +506,17 @@ The example above could log something like the following to the console:
 
 ```typescript
 {
- "index.d.ts": [
- { library: "typescript", version: "3.9.2" },
- { library: "@types/node", version: "14.0.26" }
- ],
- "some-other-chunk.d.ts": [
- { library: "some-other-external-library", version: "1.2.3" }
- ]
+ "index.d.ts": {
+ externalTypes: [
+ { library: "typescript", version: "3.9.2" },
+ { library: "@types/node", version: "14.0.26" }
+ ]
+ },
+ "some-other-chunk.d.ts": {
+ externalTypes: [
+ { library: "some-other-external-library", version: "1.2.3" }
+ ]
+ }
 }
 ```
 

src/service/emit/declaration/emit-declarations.ts

@@ -104,7 +104,9 @@ export function emitDeclarations(options: EmitDeclarationsOptions): void {
 sourceFileToImportedSymbolSet: new Map(),
 sourceFileToDependenciesMap: new Map(),
 moduleSpecifierToSourceFileMap: new Map(),
-printer: host.getPrinter()
+printer: host.getPrinter(),
+// Only prepare the record if a hook has been provided
+declarationStats: options.pluginOptions.hook.declarationStats != null ? {} : undefined
 };
 
 for (const chunk of normalizedChunks) {
@@ -202,5 +204,9 @@ export function emitDeclarations(options: EmitDeclarationsOptions): void {
 }
 }
 
+if (sharedOptions.declarationStats != null) {
+options.pluginOptions.hook.declarationStats?.(sharedOptions.declarationStats);
+}
+
 if (fullBenchmark != null) fullBenchmark.finish();
 }

src/service/transformer/declaration-bundler/declaration-bundler-options.ts

@@ -9,6 +9,7 @@ import {SourceFileToExportedSymbolSet} from "./transformers/track-exports-transf
 import {SourceFileToImportedSymbolSet} from "./transformers/track-imports-transformer/track-imports-transformer-visitor-options";
 import {ExtendedResolvedModule} from "../../cache/resolve-cache/extended-resolved-module";
 import {TypeReference} from "./util/get-type-reference-module-from-file-name";
+import {DeclarationStats} from "../../../type/declaration-stats";
 
 export type SourceFileToDependenciesMap = Map<string, Set<ExtendedResolvedModule>>;
 export type ModuleSpecifierToSourceFileMap = Map<string, TS.SourceFile>;
@@ -33,4 +34,5 @@ export interface DeclarationBundlerOptions {
 sourceFileToExportedSymbolSet: SourceFileToExportedSymbolSet;
 sourceFileToImportedSymbolSet: SourceFileToImportedSymbolSet;
 moduleSpecifierToSourceFileMap: ModuleSpecifierToSourceFileMap;
+declarationStats: DeclarationStats | undefined;
 }

src/service/transformer/declaration-bundler/transformers/source-file-bundler/source-file-bundler.ts

@@ -133,9 +133,10 @@ export function sourceFileBundler(options: DeclarationBundlerOptions, ...transfo
 }
 
 // If a declarationStats hook has been provided to the plugin, collect stats and invoke the hook with the information
-if (options.pluginOptions.hook.declarationStats != null) {
-const rawStats = statsCollector({...visitorOptions, sourceFile: transformedSourceFile});
-options.pluginOptions.hook.declarationStats(rawStats);
+if (options.declarationStats != null) {
+Object.assign(options.declarationStats, {
+[options.declarationPaths.fileName]: statsCollector({...visitorOptions, sourceFile: transformedSourceFile})
+});
 }
 
 updatedSourceFiles.push(transformedSourceFile);

src/service/transformer/declaration-bundler/transformers/stats-collector/stats-collector.ts

@@ -1,13 +1,13 @@
 import {trackImportsTransformer} from "../track-imports-transformer/track-imports-transformer";
-import {DeclarationStats} from "../../../../../type/declaration-stats";
+import {DeclarationChunkStats} from "../../../../../type/declaration-stats";
 import {StatsCollectorOptions} from "./stats-collector-options";
 import {ExtendedResolvedModule} from "../../../../cache/resolve-cache/extended-resolved-module";
 
-export function statsCollector(options: StatsCollectorOptions): DeclarationStats {
+export function statsCollector(options: StatsCollectorOptions): DeclarationChunkStats {
 const {typescript, sourceFile, declarationPaths, host, sourceFileToTypeReferencesSet} = options;
 
-const stats: DeclarationStats = {
-externalTypes: {}
+const stats: DeclarationChunkStats = {
+externalTypes: []
 };
 
 // Track all imports
@@ -40,10 +40,10 @@ export function statsCollector(options: StatsCollectorOptions): DeclarationStats
 // For each resolveResult, check if they represent external dependencies, and if so, add them to the 'externalTypes' stats
 for (const resolveResult of resolveResults) {
 if (resolveResult.isExternalLibraryImport === true && resolveResult.packageId != null) {
-if (stats.externalTypes[declarationPaths.relative] == null) {
-stats.externalTypes[declarationPaths.relative] = [];
-}
-stats.externalTypes[declarationPaths.relative].push({
+// If the external types already include this library, skip it
+if (stats.externalTypes.some(({library}) => library === resolveResult.packageId?.name)) continue;
+
+stats.externalTypes.push({
 library: resolveResult.packageId.name,
 version: resolveResult.packageId.version
 });

src/type/declaration-stats.ts

@@ -1,6 +1,9 @@
-export interface DeclarationStats {
-// A Record from chunk file names to their external type dependencies
-externalTypes: Record<string, ExternalType[]>;
+// A Record from chunk file names to their stats
+export type DeclarationStats = Record<string, DeclarationChunkStats>;
+
+export interface DeclarationChunkStats {
+// An array of the external type dependencies for a declaration chunk
+externalTypes: ExternalType[];
 }
 
 export interface ExternalType {

test/hook.test.ts

@@ -79,7 +79,7 @@ test("Diagnostics can be filtered with the 'diagnostics' hook. #1", async (t, {t
 );
 });
 
-test("External types can be retrieved with the 'declarationStats' hook. #1", async (t, {typescript, typescriptModuleSpecifier}) => {
+test.only("External types can be retrieved with the 'declarationStats' hook. #1", async (t, {typescript, typescriptModuleSpecifier}) => {
 let stats: DeclarationStats | undefined;
 
 await generateRollupBundle(
@@ -102,11 +102,10 @@ test("External types can be retrieved with the 'declarationStats' hook. #1", asy
 }
 );
 
-console.log(stats?.externalTypes);
 t.true(stats != null);
-t.true(stats?.externalTypes["index.d.ts"] != null);
-t.true(stats?.externalTypes["index.d.ts"][0] != null);
-t.true(stats?.externalTypes["index.d.ts"][0].library === "typescript");
-t.true(stats?.externalTypes["index.d.ts"][1] != null);
-t.true(stats?.externalTypes["index.d.ts"][1].library === "@types/node");
+t.true(stats?.["index.d.ts"].externalTypes != null);
+t.true(stats?.["index.d.ts"].externalTypes[0] != null);
+t.true(stats?.["index.d.ts"].externalTypes[0].library === "typescript");
+t.true(stats?.["index.d.ts"].externalTypes[1] != null);
+t.true(stats?.["index.d.ts"].externalTypes[1].library === "@types/node");
 });