feat: add FoundDeclaration type and update ambientModulesDeclarations

Author: velut

src/ambient-modules-declarations.ts

@@ -1,34 +1,24 @@
-import { ModuleDeclaration, Node, type Project } from "ts-morph";
+import { Node, type Project } from "ts-morph";
 import { isHidden } from "./is-hidden.ts";
 import { sourceFilePath } from "./source-file-path.ts";
-
-export type AmbientModulesDeclarationsReturn = {
-	containerName: string;
-	exportName: string;
-	declaration: ModuleDeclaration;
-}[];
+import type { FoundDeclaration } from "./types.ts";
 
 export function ambientModulesDeclarations(
 	containerName: string,
 	project: Project,
 	pkgName?: string,
-): AmbientModulesDeclarationsReturn {
+): FoundDeclaration[] {
 	const ambientModulesDeclarations = [];
 	for (const symbol of project.getAmbientModules()) {
 		for (const declaration of symbol.getDeclarations()) {
-			if (isHidden(declaration) || !Node.isModuleDeclaration(declaration)) {
-				continue;
-			}
-			if (pkgName && !sourceFilePath(declaration).startsWith(`/${pkgName}`)) {
-				// Ignore ambient modules that are not from the analyzed package.
-				continue;
-			}
+			if (!Node.isModuleDeclaration(declaration)) continue;
+			if (isHidden(declaration)) continue;
+
+			// Ignore ambient modules that are not from the analyzed package.
+			if (pkgName && !sourceFilePath(declaration).startsWith(`/${pkgName}`)) continue;
+
 			const exportName = declaration.getName();
-			ambientModulesDeclarations.push({
-				containerName,
-				exportName,
-				declaration,
-			});
+			ambientModulesDeclarations.push({ containerName, exportName, declaration });
 		}
 	}
 	return ambientModulesDeclarations;

src/types.ts

@@ -1,4 +1,4 @@
-import type { ModuleDeclaration, Project, SourceFile } from "ts-morph";
+import type { ExportedDeclarations, ModuleDeclaration, Project, SourceFile } from "ts-morph";
 
 /** `ExtractPackageApiOptions` contains the options for calling {@link extractPackageApi}. */
 export interface ExtractPackageApiOptions {
@@ -321,3 +321,15 @@ export interface PackageDeclarationsOptions {
 	/** Depth limit for the extraction. */
 	maxDepth: number;
 }
+
+/** `FoundDeclaration` represents a declaration found during the initial extraction process. */
+export interface FoundDeclaration {
+	/** Declaration container name. */
+	containerName: string;
+
+	/** Export name (may differ from the original name). */
+	exportName: string;
+
+	/** Declaration. */
+	declaration: ExportedDeclarations;
+}